Elaps NPM | npm.io

elaps v2.3.2

Stopwatch for high-resolution timing

const elaps = require('elaps');

// create a started timer
let t = elaps('do something');

// create a stopped timer
t = elaps.lazy('do something');

// choose where the elapsed time is printed
elaps('did something in %t').stop(true);

// print the number of laps
elaps('did something %n times').stop(true);

// util.format placeholders are supported
elaps('do something: %O', {meta:'data'}).stop(true);

// args without a placeholder default to %O
elaps('do something:', {meta:'data'}).stop(true);

`Stopwatch` class

Properties

`lap: ?Lap`

The newest Lap object created by a start() call.

Equals null when the newest lap is stopped.

`laps: number[]`

The array of lap times in order of stop time.

`elapsed: number`

The time passed (in milliseconds) with 1+ laps counting.

Updated when a pause() or stop() call leads to this.pending being zero.

Note: This not the same as sum(), which combines the individual lap times.

`pending: number`

The number of pending laps (neither paused nor stopped).

`msg: string`

The message passed to the elaps constructor.

Printed by stop(true) and print() calls.

Use %t to print the elapsed time.

Use %n to print the number of laps.

`log: Function`

The function called by the print method.

Defaults to elaps.log || console.log.

Methods

`start(): Lap`

Start a new lap.

Update the value of this.lap to the new lap.

`stop(print: ?boolean): this`

Stop the current lap.

Pass true to print the lap time.

`print(time: ?number): this`

Print this.msg with given time (in milliseconds) or this.elapsed.

You can pass a string (followed by any other values) to override this.msg for one call only. To override both the time and message, the time must come first.