Options for the formatMilliseconds function.

interface FormatMillisecondsOptions {
    colonNotation?: boolean;
    compact?: boolean;
    formatSubMilliseconds?: boolean;
    keepDecimalsOnWholeSeconds?: boolean;
    millisecondsDecimalDigits?: number;
    secondsDecimalDigits?: number;
    separateMilliseconds?: boolean;
    unitCount?: number;
    verbose?: boolean;
}

Properties

colonNotation?: boolean

Display time using colon notation: 5h 1m 45s5:01:45. Always shows time in at least minutes: 1s0:01

Useful when you want to display time without the time units, similar to a digital watch.

Setting colonNotation to true overrides the following options to false:

  • compact
  • formatSubMilliseconds
  • separateMilliseconds
  • verbose
compact?: boolean

Only show the first unit: 1h 10m1h.

Also ensures that millisecondsDecimalDigits and secondsDecimalDigits are both set to 0.

formatSubMilliseconds?: boolean

Show microseconds and nanoseconds.

keepDecimalsOnWholeSeconds?: boolean

Keep milliseconds on whole seconds: 13s13.0s.

Useful when you are showing a number of seconds spent on an operation and don't want the width of the output to change when hitting a whole number.

millisecondsDecimalDigits?: number

Number of digits to appear after the milliseconds decimal point.

Useful in combination with process.hrtime().

secondsDecimalDigits?: number

Number of digits to appear after the seconds decimal point.

separateMilliseconds?: boolean

Show milliseconds separately. This means they won't be included in the decimal part of the seconds.

unitCount?: number

Number of units to show. Setting compact to true overrides this option.

verbose?: boolean

Use full-length units: 5h 1m 45s5 hours 1 minute 45 seconds.