Kevin 78286fd3b3 add template | 4 years ago | |
---|---|---|
.. | ||
LICENSE | 4 years ago | |
README.md | 4 years ago | |
index.js | 4 years ago | |
package.json | 4 years ago | |
utils.js | 4 years ago |
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 with npm:
$ npm install --save pretty-time
var pretty = require('pretty-time');
var start = process.hrtime();
var time = process.hrtime(start);
console.log(pretty(time));
//=> 3μs
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:
pretty([1200708, 795428088]);
//=> '2w'
pretty([800708, 795428088]);
//=> '1w'
pretty([400708, 795428088]);
//=> '5d'
pretty([70708, 795428088]);
//=> '20h'
pretty([12708, 795428088]);
//=> '4h'
pretty([3708, 795428088]);
//=> '1h'
pretty([208, 795428088]);
//=> '3m'
pretty([20, 795428088]);
//=> '21s'
pretty([0, 795428088]);
//=> '795ms'
pretty([0, 000428088]);
//=> '428μs'
pretty([0, 000000088]);
//=> '88ns'
pretty([0, 000000018]);
//=> '18ns'
(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
pretty(time, 'h');
//=> '2h'
pretty(time, 'm');
//=> '1h 52m'
pretty(time, 's');
//=> '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
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
You might also be interested in these projects:
| Commits | Contributor | | --- | --- | | 14 | jonschlinkert | | 5 | doowb |
Jon Schlinkert
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on July 12, 2018.