pretty-time

Easily format the time from node.js process.hrtime. Works with timescales ranging from weeks to nanoseconds.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

1$ npm install --save pretty-time

Usage

1var pretty = require('pretty-time');
2
3var start = process.hrtime();
4var time = process.hrtime(start);
5console.log(pretty(time));
6//=> 3μs

API

By default, when no time increment is given as the second argument, the closest timescale is used (e.g. most granular without being less than zero).

Examples:

1pretty([1200708, 795428088]);
2//=> '2w'
3
4pretty([800708, 795428088]);
5//=> '1w'
6
7pretty([400708, 795428088]);
8//=> '5d'
9
10pretty([70708, 795428088]);
11//=> '20h'
12
13pretty([12708, 795428088]);
14//=> '4h'
15
16pretty([3708, 795428088]);
17//=> '1h'
18
19pretty([208, 795428088]);
20//=> '3m'
21
22pretty([20, 795428088]);
23//=> '21s'
24
25pretty([0, 795428088]);
26//=> '795ms'
27
28pretty([0, 000428088]);
29//=> '428μs'
30
31pretty([0, 000000088]);
32//=> '88ns'
33
34pretty([0, 000000018]);
35//=> '18ns'

Minimum time increment

(All of the following examples use [6740, 795428088] as the hrtime array.)

This value is passed as the second argument and determines how granular to make the time.

Examples

1pretty(time, 'h');
2//=> '2h'
3
4pretty(time, 'm');
5//=> '1h 52m'
6
7pretty(time, 's');
8//=> '1h 52m 21s'

Valid time increments

Any of the following may be used:

• ns | nano | nanosecond | nanoseconds
• μs | micro | microsecond | microseconds
• ms | milli | millisecond | milliseconds
• s | sec | second | seconds
• m | min | minute | minutes
• h | hr | hour | hours
• d | day | days
• w | wk | week | weeks

About

1$ npm install && npm test

1$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• o-clock: Simple javascript utility for displaying the time in 12-hour clock format. | homepage
• seconds: Get the number of seconds for a minute, hour, day and week. | homepage
• time-stamp: Get a formatted timestamp. | homepage
• timescale: Convert from one time scale to another. Nanosecond is the most atomic unit, week is… more | homepage
• week: Get the current week number. | homepage
• weekday: Get the name and number of the current weekday. Or get the name of the… more | homepage
• year: Simple utility to get the current year with 2 or 4 digits. | homepage

Contributors

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on July 12, 2018.