Simple Rate Limiter Middleware

Installation

1# Using npm
2> npm install simple-rate-limiter-middleware
3# Using yarn or pnpm
4> yarn/pnpm add simple-rate-limiter-middleware

Usage

Importing

This library is provided in ESM as well as CJS forms, and works with both Javascript and Typescript projects.

Import it in a CommonJS project (type: commonjs or no type field in package.json) as follows:

1const { rateLimit, MemoryStore } = require("simple-rate-limiter-middleware");

Import it in a ESM project (type: module in package.json) as follows:

1import { rateLimit, MemoryStore } from "simple-rate-limiter-middleware";

Examples

To use it in an API-only server where the rate-limiter should be applied to all requests:

1const { rateLimit, MemoryStore } = require("simple-rate-limiter-middleware");
2
3const rateLimiter = rateLimit({
4  statusCode: 429,
5  message: "Example response message.",
6  legacyHeaders: false,
7  standardHeaders: true,
8  store: new MemoryStore(60, 10),
9});
10
11app.use(rateLimiter);

You can also create multiple instance and apply then to different places of your API.

Troubleshooting Proxy Issues

If you are behind a proxy/load balancer (usually the case with most hosting services, e.g. Heroku, Bluemix, AWS ELB, Nginx, Cloudflare, Akamai, Fastly, Firebase Hosting, Rackspace LB, Riverbed Stingray, etc.), the IP address of the request might be the IP of the load balancer/reverse proxy (making the rate limiter effectively a global one and blocking all requests once the limit is reached) or undefined. To solve this issue, add the following line to your code (right after you create the express application):

1app.set("trust proxy", numberOfProxies);

Where numberOfProxies is the number of proxies between the user and the server.

For more information about the trust proxy setting, take a look at the official Express documentation.

Issues and Contributing

If you encounter a bug or want to see something added/changed, please go ahead and open an issue! If you need help with something, feel free to start a discussion!

Fell free to contribute to the library.