Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

blocked

1.3.0 • Public • Published

blocked

Check if a node event loop is blocked.

If You're running Node.js 8+ you can get a stacktrace pointing to the blocking function using very similar blocked-at package.

Installation

$ npm install blocked

Description

The blocked() function reports every value over the configured threshold (defaulted to 10ms). You can then do whatever you want with that value, graph it, log it, alert, etc.

The process won't be kept open through this.

Params and return value

var timer = blocked(fn, options);
  • fn: The callback function to execute when the event loop is blocked. Will send in the amount of time in ms that the event loop was blocked.
  • options: Optional. Options object to configure the behaviour.
    • threshold determines the amount of ms used to determine if the function callback should be executed; useful to speed up tests.
    • interval determines the frequency with which the event loop is checked in ms.
blocked(function(ms) {
    console.log("Blocked");
}, {threshold:1, interval: 1000});

Returns: A reference to the timer. Useful for clearing the timer.

var timer = blocked(function(ms) {
                console.log("Blocked");
            });
clearInterval(timer);

License

MIT

Install

npm i blocked

DownloadsWeekly Downloads

60,244

Version

1.3.0

License

MIT

Unpacked Size

3.65 kB

Total Files

5

Last publish

Collaborators

  • avatar
  • avatar
  • avatar