@directus/pressure
v2.0.0
Published
Pressure based rate limiter
Downloads
49,717
Readme
@directus/pressure
Pressure based rate limiter
Description
This package exports a pressure based rate limiter that is used within Directus, an open-source headless CMS.
For more information about Directus, visit the official website.
Installation
npm install @directus/pressure
Usage
Standalone
The pressure monitor is a class that can be used anywhere:
import { PressureMonitor } from '@directus/pressure';
const monitor = new PressureMonitor({
maxEventLoopUtilization: 0.8,
});
monitor.overloaded; // true | false
Express
The library also exports an express middleware that can be used to throw an Error when the pressure monitor reports overloaded:
import express from 'express';
import { handlePressure } from '@directus/pressure';
const app = express();
app.use(
handlePressure({
maxEventLoopUtilization: 0.8,
}),
);
License
This package is licensed under the MIT License. See the LICENSE file for more information.