@stdlib/time-toc

Return a high-resolution time difference.


Keywords
stdlib, stdtime, utilities, utility, utils, util, time, timer, tic, toc, process.hrtime, performance.now, performance, perf, now, high-resolution, clock, delta, elapsed, difference, javascript, node, node-js, nodejs
License
Apache-2.0
Install
npm install @stdlib/time-toc@0.0.6

Documentation

toc

NPM version Build Status Coverage Status dependencies

Return a high-resolution time difference.

Installation

npm install @stdlib/time-toc

Usage

var toc = require( '@stdlib/time-toc' );

toc( time )

Returns a high-resolution time difference, where time is a two-element array with format [seconds, nanoseconds].

var delta = toc( [ 100, 123456789 ] );
// returns [<number>,<number>]

Similar to time, the returned array has format [seconds, nanoseconds].

Notes

  • This function is intended to be used in conjunction with tic for measuring performance between intervals.

Examples

var tic = require( '@stdlib/time-tic' );
var toc = require( '@stdlib/time-toc' );

var start = tic();

setTimeout( onTimeout, 2000 );

function onTimeout() {
    var elapsed = toc( start );
    console.log( 'Elapsed: %d seconds and %d nanoseconds', elapsed[0], elapsed[1] );
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.