@public
function
useFormattedDuration
()
Formats a duration (in milliseconds) to a more user friendly string eg 1h 30m
or 1t 29m 15s
. Can be configured to output full units, eg 1 hour 30 minutes
or 1 hour 3 minutes 15 seconds
. Uses the current locale, which also applies to the division of units.
Import
import {useFormattedDuration} from 'sanity'
Signature
function useFormattedDuration(durationMs: number, options: UseFormattedDurationOptions): FormattedDuration
function useFormattedDuration(durationMs: number, options: UseFormattedDurationOptions): FormattedDuration
Returns
FormattedDuration
FormattedDuration
An object with formatted
and iso8601
properties
Examples
Example #1
English (en-US) locale formatting
useFormattedDuration(5589000)
// {"formatted": "1 hour, 33 minutes, and 9 seconds", "iso8601": "PT1H33M9S"}
Example #2
Norwegian (no-NB) locale formatting
useFormattedDuration(5589000)
// {"formatted": "1 time, 33 minutter og 9 sekunder", "iso8601": "PT1H33M9S"}