Optional
colonDisplay time using colon notation: 5h 1m 45s
→ 5:01:45
. Always shows time in at least minutes: 1s
→ 0: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
Optional
compactOnly show the first unit: 1h 10m
→ 1h
.
Also ensures that millisecondsDecimalDigits
and secondsDecimalDigits
are both set to 0
.
Optional
formatShow microseconds and nanoseconds.
Optional
keepKeep milliseconds on whole seconds: 13s
→ 13.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.
Optional
millisecondsNumber of digits to appear after the milliseconds decimal point.
Useful in combination with process.hrtime()
.
Optional
secondsNumber of digits to appear after the seconds decimal point.
Optional
separateShow milliseconds separately. This means they won't be included in the decimal part of the seconds.
Optional
unitNumber of units to show. Setting compact
to true
overrides this option.
Optional
verboseUse full-length units: 5h 1m 45s
→ 5 hours 1 minute 45 seconds
.
Options for the
formatMilliseconds
function.