loopbench

Benchmark your event loop, extracted from hapi,
hoek, heavy and
boom.

* Install
* Example
* API
* Acknowledgements
* License

Install

To install loopbench, simply use npm:

``
npm i loopbench --save
`




Example

See [example.js][example].




API

* loopbench()
* instance.delay
* instance.limit
* instance.overLimit
* instance.stop()

-------------------------------------------------------



$3

Creates a new instance of loopbench.

Options:

* sampleInterval: the interval at which the eventLoop should be
sampled, defaults to 5.
* limit: the maximum amount of delay that is tollerated before
overLimit becomes true, and the load event is
emitted, defaults to 42.

Events:

* load, emitted when instance.delay > instance.limit
* unload, emitted when overLimit goes from true and false

-------------------------------------------------------



$3

The delay in milliseconds (and fractions) from the expected run.
It might be negative (in older nodes).

-------------------------------------------------------



$3

The maximum amount of delay that is tollerated before
overLimit becomes true, and the load event is
emitted.

-------------------------------------------------------



$3

Is true if the instance.delay > instance.limit`.

-------------------------------------------------------

$3

Stops the sampling.

License

Copyright Matteo Collina 2015-2022, Licensed under [MIT][].

[MIT]: ./LICENSE
[example]: ./example.js