Skip to content

Latest commit

 

History

History
87 lines (62 loc) · 2.13 KB

README.md

File metadata and controls

87 lines (62 loc) · 2.13 KB
Raw

loopbench

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

Install

To install loopbench, simply use npm:

npm i loopbench --save

Example

See example.js.

API

loopbench([opts])

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

instance.delay

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

instance.limit

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

instance.overLimit

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

instance.stop()

Stops the sampling.

License

Copyright Matteo Collina 2015-2022, Licensed under MIT.