pretty-mslux
Convert milliseconds to a human readable string:
1337000000
→15d 11h 23m 20s
Install
$ npm install pretty-mslux
Usage
const prettyMs = ; ;//=> '15d 11h 23m 20s' ;//=> '1.3s' ;//=> '133ms' // `compact` option;//=> '~1s' // `verbose` option;//=> '15 days 11 hours 1 minute 9 seconds' // `formatSubMs` option//=> '100ms 400µs 80ns' // Can be useful for time durations//=> '35m'
API
prettyMs(input, [options])
input
Type: number
Milliseconds to humanize.
options
Type: Object
secDecimalDigits
Type: number
Default: 1
Number of digits to appear after the seconds decimal point.
msDecimalDigits
Type: number
Default: 0
Number of digits to appear after the milliseconds decimal point.
Useful in combination with process.hrtime()
.
keepDecimalsOnWholeSeconds
Type: boolean
Default: false
Keep 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.
compact
Type: boolean
Default: false
Only show the first unit: 1h 10m
→ ~1h
.
Also ensures that msDecimalDigits
and secDecimalDigits
are both set to 0
.
unitCount
Type: number
Default: Infinity
Number of units to show. Setting compact
to true
overrides this option.
verbose
Type: boolean
Default: false
Use full-length units: 5h 1m 45s
→ 5 hours 1 minute 45 seconds
separateMs
Type: boolean
Default: false
Show milliseconds separately. This means they won't be included in the decimal part of the seconds.
formatSubMs
Type: boolean
Default: false
Show microseconds and nanoseconds.
Related
- pretty-mslux-cli - CLI for this module
- parse-ms - Parse milliseconds into an object
- to-milliseconds - Convert an object of time properties to milliseconds
License
MIT © Sindre Sorhus