https://github.com/tj/node-blocked
Check if the event loop is blocked
https://github.com/tj/node-blocked
Last synced: 6 months ago
JSON representation
Check if the event loop is blocked
- Host: GitHub
- URL: https://github.com/tj/node-blocked
- Owner: tj
- Created: 2014-06-01T18:54:00.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-10-25T16:08:40.000Z (about 6 years ago)
- Last Synced: 2025-05-24T18:05:33.548Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 734
- Watchers: 14
- Forks: 36
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
- Changelog: History.md
Awesome Lists containing this project
README
# 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](https://github.com/naugtur/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
```js
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.
```js
blocked(function(ms) {
console.log("Blocked");
}, {threshold:1, interval: 1000});
```
Returns: A reference to the timer. Useful for clearing the timer.
```js
var timer = blocked(function(ms) {
console.log("Blocked");
});
clearInterval(timer);
```
# License
MIT