[go: up one dir, main page]

pretty-ms
TypeScript icon, indicating that this package has built-in type declarations

9.2.0 • Public • Published

pretty-ms

Convert milliseconds to a human readable string: 133700000015d 11h 23m 20s

Install

npm install pretty-ms

Usage

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().

keepDecimalsOnWholeSeconds

Type: boolean
Default: false

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.

compact

Type: boolean
Default: false

Only show the first unit: 1h 10m1h.

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 45s5 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 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
hideYear

Type: boolean
Default: false

Hides the year and shows the hidden year additionally as days (365 per year): 1y 3d 5h 1m 45s368d 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 45s8837h 1m 45s.

hideSeconds

Type: boolean
Default: false

Hides the seconds: 1y 3d 5h 1m 45s1y 3d 5h 1m.

Related

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
9.2.0176,083latest

Version History

VersionDownloads (Last 7 Days)Published
9.2.0176,083
9.1.01,271,492
9.0.0478,276
8.0.0386,806
7.0.13,270,817
7.0.044,655
6.0.122,901
6.0.02,958
5.1.0139,948
5.0.010,859
4.0.030,787
3.2.092,000
3.1.019,162
3.0.15,737
3.0.03,074
2.1.0163,925
2.0.066
1.4.010,295
1.3.00
1.2.11
1.2.01
1.1.013
1.0.12
1.0.017
0.2.265,786
0.2.17
0.1.05,797

Package Sidebar

Install

npm i pretty-ms

Weekly Downloads

6,201,465

Version

9.2.0

License

MIT

Unpacked Size

13.5 kB

Total Files

5

Last publish

Collaborators

  • sindresorhus