https://github.com/seriousManual/hirestime

thin wrapper around process.hrtime
https://github.com/seriousManual/hirestime

hacktoberfest

Last synced: about 2 months ago
JSON representation

thin wrapper around process.hrtime

• Host: GitHub
• URL: https://github.com/seriousManual/hirestime
• Owner: seriousManual
• License: mit
• Created: 2013-12-03T21:31:28.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-02-15T10:22:50.000Z (4 months ago)
• Last Synced: 2024-04-16T13:59:20.910Z (2 months ago)
• Topics: hacktoberfest
• Language: TypeScript
• Homepage:
• Size: 640 KB
• Stars: 16
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-micro-npm-packages - hirestime - A wrapper around the built-in high resolution timer which simplifies the calculation of timestamps. (Modules / Date & Time)
• awesome-micro-npm-packages - hirestime - A wrapper around the built-in high resolution timer which simplifies the calculation of timestamps. (Modules / Date & Time)

README

        
# hirestime [![Build Status](https://api.travis-ci.org/seriousManual/hirestime.png)](https://travis-ci.org/seriousManual/hirestime)

`hirestime` is a thin wrapper around the common time measuring APIs (node and the browser).

Uses `process.hrtime()` on node, the [performance API](https://developer.mozilla.org/de/docs/Web/API/Performance/now) in the browser and falls back to `Date` if neither is available.

## Installation

````bash

npm install hirestime

````

## hirestime()

returns a function:

### returnedFunction()

Returns the elapsed time since the call of `hirestime` in milliseconds.    

## Examples

By default the time is measured in milliseconds:

````javascript

import hirestime from 'hirestime'

//startpoint of the time measurement

const getElapsed = hirestime()

setTimeout(_ => {

    //returns the elapsed milliseconds

    console.log(getElapsed())

}, 1000)

````

Specify the unit:

 ````javascript

import hirestime from '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)

````