BlueGit

blue-star danique-bot

Files

danique-bot / node_modules / performance-now / README.md

README.md

Import template
timfa Tim · pushed by timfa · 4 years ago
c788ad20 History
README.md 2.0 KiB Download Raw

performance-now Build Status Dependency Status

Implements a function similar to performance.now (based on process.hrtime).

Modern browsers have a window.performance object with - among others - a now method which gives time in milliseconds, but with sub-millisecond precision. This module offers the same function based on the Node.js native process.hrtime function.

Using process.hrtime means that the reported time will be monotonically increasing, and not subject to clock-drift.

According to the High Resolution Time specification, the number of milliseconds reported by performance.now should be relative to the value of performance.timing.navigationStart.

In the current version of the module (2.0) the reported time is relative to the time the current Node process has started (inferred from process.uptime()).

Version 1.0 reported a different time. The reported time was relative to the time the module was loaded (i.e. the time it was first required). If you need this functionality, version 1.0 is still available on NPM.

Example usage

var now = require("performance-now")
var start = now()
var end = now()
console.log(start.toFixed(3)) // the number of milliseconds the current node process is running
console.log((start-end).toFixed(3)) // ~ 0.002 on my system

Running the now function two times right after each other yields a time difference of a few microseconds. Given this overhead, I think it's best to assume that the precision of intervals computed with this method is not higher than 10 microseconds, if you don't know the exact overhead on your own system.

License

performance-now is released under the MIT License. Copyright (c) 2017 Braveg1rl

Source
1# performance-now [![Build Status](https://travis-ci.org/braveg1rl/performance-now.png?branch=master)](https://travis-ci.org/braveg1rl/performance-now) [![Dependency Status](https://david-dm.org/braveg1rl/performance-now.png)](https://david-dm.org/braveg1rl/performance-now)
2
3Implements a function similar to `performance.now` (based on `process.hrtime`).
4
5Modern browsers have a `window.performance` object with - among others - a `now` method which gives time in milliseconds, but with sub-millisecond precision. This module offers the same function based on the Node.js native `process.hrtime` function.
6
7Using `process.hrtime` means that the reported time will be monotonically increasing, and not subject to clock-drift.
8
9According to the [High Resolution Time specification](http://www.w3.org/TR/hr-time/), the number of milliseconds reported by `performance.now` should be relative to the value of `performance.timing.navigationStart`.
10
11In the current version of the module (2.0) the reported time is relative to the time the current Node process has started (inferred from `process.uptime()`).
12
13Version 1.0 reported a different time. The reported time was relative to the time the module was loaded (i.e. the time it was first `require`d). If you need this functionality, version 1.0 is still available on NPM.
14
15## Example usage
16
17```javascript
18var now = require("performance-now")
19var start = now()
20var end = now()
21console.log(start.toFixed(3)) // the number of milliseconds the current node process is running
22console.log((start-end).toFixed(3)) // ~ 0.002 on my system
23```
24
25Running the now function two times right after each other yields a time difference of a few microseconds. Given this overhead, I think it's best to assume that the precision of intervals computed with this method is not higher than 10 microseconds, if you don't know the exact overhead on your own system.
26
27## License
28
29performance-now is released under the [MIT License](http://opensource.org/licenses/MIT).
30Copyright (c) 2017 Braveg1rl