Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/pretty-ms
Convert milliseconds to a human readable string: `1337000000` → `15d 11h 23m 20s`
https://github.com/sindresorhus/pretty-ms
humanize milliseconds npm-package
Last synced: 2 days ago
JSON representation
Convert milliseconds to a human readable string: `1337000000` → `15d 11h 23m 20s`
- Host: GitHub
- URL: https://github.com/sindresorhus/pretty-ms
- Owner: sindresorhus
- License: mit
- Created: 2014-03-20T14:36:57.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-07-23T23:35:01.000Z (5 months ago)
- Last Synced: 2024-10-29T15:03:08.174Z (about 1 month ago)
- Topics: humanize, milliseconds, npm-package
- Language: JavaScript
- Homepage:
- Size: 88.9 KB
- Stars: 1,075
- Watchers: 11
- Forks: 65
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: license
- Security: .github/security.md
Awesome Lists containing this project
- awesome - sindresorhus/pretty-ms - Convert milliseconds to a human readable string: `1337000000` → `15d 11h 23m 20s` (JavaScript)
- awesome-frontend - pretty-ms - Convert milliseconds to a human readable string: `1337000000` → `15d 11h 23m 20s`  (Repository / Date & Time)
- awesome-nodejs-cn - pretty-ms - 将毫秒数转化为可读时间字符串: ```1337000000``` → ```15d 11h 23m 20s``` (包 / 人性化)
- awesome-nodejs - pretty-ms - Convert milliseconds to a human readable string: `1337000000` → `15d 11h 23m 20s`  (Repository / Date & Time)
- awesome-nodejs-cn - pretty-ms - **star:1074** 将毫秒转换为人类可读的字符串:“1337000000”→“15d 11h 23m 20s” (包 / 人性化)
- awesome-nodejs - pretty-ms - Convert milliseconds to a human readable string: `1337000000` → `15d 11h 23m 20s`. (Packages / Humanize)
- awesome-nodejs - pretty-ms - Convert milliseconds to a human readable string: `1337000000` → `15d 11h 23m 20s` - ★ 347 (Humanize)
- awesome-node - pretty-ms - Convert milliseconds to a human readable string: `1337000000` → `15d 11h 23m 20s`. (Packages / Humanize)
- awesome-nodejs-cn - pretty-ms - Convert milliseconds to a human readable string: `1337000000` → `15d 11h 23m 20s`. (目录 / 人性化)
README
# pretty-ms
> Convert milliseconds to a human readable string: `1337000000` → `15d 11h 23m 20s`
## Install
```sh
npm install pretty-ms
```
## Usage
```js
import prettyMilliseconds from 'pretty-ms';
prettyMilliseconds(1337000000);
//=> '15d 11h 23m 20s'
prettyMilliseconds(1337000000n);
//=> '15d 11h 23m 20s'
prettyMilliseconds(1337);
//=> '1.3s'
prettyMilliseconds(133);
//=> '133ms'
// `compact` option
prettyMilliseconds(1337, {compact: true});
//=> '1s'
// `verbose` option
prettyMilliseconds(1335669000, {verbose: true});
//=> '15 days 11 hours 1 minute 9 seconds'
// `colonNotation` option
prettyMilliseconds(95500, {colonNotation: true});
//=> '1:35.5'
// `formatSubMilliseconds` option
prettyMilliseconds(100.400080, {formatSubMilliseconds: true})
//=> '100ms 400µs 80ns'
// Can be useful for time durations
prettyMilliseconds(new Date(2014, 0, 1, 10, 40) - new Date(2014, 0, 1, 10, 5))
//=> '35m'
```
## API
### prettyMilliseconds(milliseconds, options?)
#### milliseconds
Type: `number | bigint`
Milliseconds to humanize.
#### options
Type: `object`
##### secondsDecimalDigits
Type: `number`\
Default: `1`
Number of digits to appear after the seconds decimal point.
##### millisecondsDecimalDigits
Type: `number`\
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_time).
##### 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 `millisecondsDecimalDigits` and `secondsDecimalDigits` 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`
##### separateMilliseconds
Type: `boolean`\
Default: `false`
Show milliseconds separately. This means they won't be included in the decimal part of the seconds.
##### formatSubMilliseconds
Type: `boolean`\
Default: `false`
Show microseconds and nanoseconds.
##### colonNotation
Type: `boolean`\
Default: `false`
Display 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`
##### hideYear
Type: `boolean`\
Default: `false`
Hides the year and shows the hidden year additionally as days (365 per year): `1y 3d 5h 1m 45s` → `368d 5h 1m 45s`.
##### hideYearAndDays
Type: `boolean`\
Default: `false`
Hides the year and days and shows the hidden values additionally as hours: `1y 3d 5h 1m 45s` → `8837h 1m 45s`.
##### hideSeconds
Type: `boolean`\
Default: `false`
Hides the seconds: `1y 3d 5h 1m 45s` → `1y 3d 5h 1m`.
## Related
- [pretty-ms-cli](https://github.com/sindresorhus/pretty-ms-cli) - CLI for this module
- [parse-ms](https://github.com/sindresorhus/parse-ms) - Parse milliseconds into an object
- [to-milliseconds](https://github.com/sindresorhus/to-milliseconds) - Convert an object of time properties to milliseconds
- [pretty-bytes](https://github.com/sindresorhus/pretty-bytes) - Convert bytes to a human readable string