formatDuration()function
formatDuration(duration: DurationData, options?: DurationFormatOptions): string
| Param | Type | |
|---|---|---|
duration | DurationData | DurationData object to format. required |
options | DurationFormatOptions | Formatting options passed through to Intl.DurationFormat. |
| Return | |
|---|---|
string | Human-readable string describing the duration. |
Format a duration as a string, e.g. 1 year, 2 months, 3 days or 1y 2m 3d
Examples
formatDuration({ years: 1, months: 2, days: 3 }) // "1 yr, 2 mths, 3 days"