hirestime

hirestime

hirestime is a thin wrapper around the common time measuring APIs (node and the browser). Uses process.hrtime() on node, the performance API in the browser and falls back to Date if neither is available.

Installation

npm install hirestime

hirestime()

returns a function:

returnedFunction([unit])

Returns the elapsed time since the call of hirestime in milliseconds.
An optional unit parameter can be specified that will modify the unit in which the elapsed time will be calculated. Using the parameter is deprecated though, instead you should use the namend methods to specify the recalculation unit.

Possible Parameters (deprecated)

• hirestime.S elapsed time in seconds
• hirestime.MS elapsed time in milliseconds
• hirestime.NS elapsed time in nanoseconds

Examples

By default the time is measured in milliseconds:

const hirestime = require('hirestime')

//startpoint of the time measurement
const getElapsed = hirestime()

setTimeout(_ => {
    //returns the elapsed milliseconds
    console.log(getElapsed())
}, 1000)

Specify the unit:

const hirestime = require('hirestime')

//startpoint of the time measurement
const getElapsed = hirestime()

setTimeout(_ => {
   //returns the elapsed seconds
   console.log(getElapsed.s())
   console.log(getElapsed.seconds())

   //returns the elapsed milliseconds
   console.log(getElapsed.ms())
   console.log(getElapsed.milliseconds())

   //returns the elapsed nanoseconds
   console.log(getElapsed.ns())
   console.log(getElapsed.nanoseconds())
}, 1000)

Optionally the unit can be set to be seconds or nanoseconds (deprecated):

const hirestime = require('hirestime')

//startpoint of the time measurement
const getElapsed = hirestime()

setTimeout(_ => {
   //returns the elapsed seconds
   console.log(getElapsed(hirestime.S))
}, 1000)