Package Exports

durations

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (durations) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Stopwatch

A nanosecond granularity (on Node.js) stopwatch with chainable control methods, and built-in formatting.

Timer

Times the execution of a function, and returns the duration.

Duration

Represents a duration with nanosecond granularity, and provides methods for converting to other granularities, and formatting the duration.

Installation

npm install --save durations

Usage

durations = require 'durations'

watch = durations.stopwatch()
watch.stop()  # Pauses the stopwatch. Returns the stopwatch.
watch.start() # Starts the stopwatch from where it was last stopped. Returns the stopwatch.
watch.reset() # Reset the stopwatch (duration is set back to zero). Returns the stopwatch.
duration = watch.duration() # Returns the Duration.

console.log "Took", durations.time(someFunction), "to do something."

durations.timeAsync(someFunction).then((duration) ->
  console.log "Took", duration.format(), "to do something."
)

console.log "Duration is", durations.duration(nanoseconds).format()

Compatibilty

The durations module uses the browser-process-hrtime module to support both the Node.js and browsers. When using Node.js, the nanosecond-granulatiry process.hrtime() function is used. The best substitution is selected when in the browser such that consistency is maintained even if time granularity cannot be.