clean-jsdoc-theme TypeDoc APIv0.0.0

formatDuration

formatDuration( ms: number, options: { verbose?: boolean }, ): string

Source: date.ts:500

Formats a duration in milliseconds to a human-readable string

Parameters

  • ms (number) — Duration in milliseconds
  • options ({ verbose?: boolean }, default: "{}") — Formatting options

Properties

  • verbose (boolean, optional)

Returns

  • string — Formatted duration string

Example

CODE
formatDuration(3661000) // '1h 1m 1s'
formatDuration(86400000) // '1d'
formatDuration(3600000, { verbose: true }) // '1 hour'