Function formatTimeDuration

formatTimeDuration(
    ms: number,
    opts?: {
        decimals?: number;
        unit?: "sec" | "min" | "hour" | "day" | "week" | "month" | "year";
    },
): string
Formats a millisecond duration into a human-readable string.

WHY: Converts raw millisecond values into user-friendly strings for display. Automatically selects the most appropriate unit (sec, min, hour, day, etc.).
Parameters
- ms: number
  number of milliseconds to format
- opts: {
  decimals?: number;
  unit?: "sec" | "min" | "hour" | "day" | "week" | "month" | "year";
  } = {}
  optional formatting options
  - Optionaldecimals?: number
    number of decimal places (default: 0 for whole units, 1 for fractional)
  - Optionalunit?: "sec" | "min" | "hour" | "day" | "week" | "month" | "year"
    force a specific unit instead of auto-selecting
Returns string
formatted string (e.g., "30sec", "5min", "2hour")
Example
```
formatTimeDuration(1000);          // "1sec"
formatTimeDuration(30000);         // "30sec"
formatTimeDuration(90000);         // "1.5min"
formatTimeDuration(3600000);       // "1hour"
formatTimeDuration(86400000);      // "1day"
```
Example
```
// Force specific unit
formatTimeDuration(90000, { unit: 'sec' });  // "90sec"
formatTimeDuration(90000, { unit: 'min' });  // "1.5min"
```
Example
```
// Control decimals
formatTimeDuration(90000, { decimals: 0 });  // "2min"
formatTimeDuration(90000, { decimals: 2 });  // "1.50min"
```
Example
```
// Display cache expiry times
console.log(`Cache expires in: ${formatTimeDuration(cache.ttl)}`);
```
- Defined in packages/utils/src/units/time.ts:233

Function formatTimeDuration

Parameters

`Optional`decimals?: number

`Optional`unit?: "sec" | "min" | "hour" | "day" | "week" | "month" | "year"

Returns string

Example

Example

Example

Example

Settings

Function formatTimeDuration

Parameters

Optionaldecimals?: number

Optionalunit?: "sec" | "min" | "hour" | "day" | "week" | "month" | "year"

Returns string

Example

Example

Example

Example

Settings

`Optional`decimals?: number

`Optional`unit?: "sec" | "min" | "hour" | "day" | "week" | "month" | "year"