blob: 01bab490b71b16804e7d9ff213968fb9cc9fe047 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
# pretty-ms [](https://travis-ci.org/sindresorhus/pretty-ms)
> Convert milliseconds to a human readable string: `1337000000` → `15d 11h 23m 20s`
## Usage
```
$ npm install pretty-ms
```
```js
const prettyMs = require('pretty-ms');
prettyMs(1337000000);
//=> '15d 11h 23m 20s'
prettyMs(1337);
//=> '1.3s'
prettyMs(133);
//=> '133ms'
// compact option
prettyMs(1337, {compact: true});
//=> '~1s'
// verbose option
prettyMs(1335669000, {verbose: true});
//=> '15 days 11 hours 1 minute 9 seconds'
// can be useful for time durations
prettyMs(new Date(2014, 0, 1, 10, 40) - new Date(2014, 0, 1, 10, 5))
//=> '35m'
```
## API
### prettyMs(input, [options])
#### input
Type: `number`
Milliseconds to humanize.
#### options
Type: `Object`
##### secDecimalDigits
Type: `number`<br>
Default: `1`
Number of digits to appear after the seconds decimal point.
##### msDecimalDigits
Type: `number`<br>
Default: `0`
Number of digits to appear after the milliseconds decimal point.
Useful in combination with [`process.hrtime()`](https://nodejs.org/api/process.html#process_process_hrtime).
##### keepDecimalsOnWholeSeconds
Type: `boolean`<br>
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`<br>
Default: `false`
Only show the first unit: `1h 10m` → `~1h`.
##### verbose
Type: `boolean`<br>
Default: `false`
Use full-length units: `5h 1m 45s` → `5 hours 1 minute 45 seconds`
## Related
- [pretty-ms-cli](https://github.com/sindresorhus/pretty-ms-cli) - CLI for this module
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)
|
