@types/express-rate-limit

What is @types/express-rate-limit?

@types/express-rate-limit provides TypeScript type definitions for the express-rate-limit middleware, which is used to limit repeated requests to public APIs and/or endpoints in an Express application.

What are @types/express-rate-limit's main functionalities?

Basic Rate Limiting

This feature allows you to set up basic rate limiting for your Express application. The code sample demonstrates how to limit each IP to 100 requests per 15 minutes.

const rateLimit = require('express-rate-limit');
const limiter = rateLimit({
  windowMs: 15 * 60 * 1000, // 15 minutes
  max: 100 // limit each IP to 100 requests per windowMs
});
app.use(limiter);

Custom Response

This feature allows you to customize the response message when the rate limit is exceeded. The code sample shows how to send a custom message when the limit is reached.

const rateLimit = require('express-rate-limit');
const limiter = rateLimit({
  windowMs: 15 * 60 * 1000, // 15 minutes
  max: 100, // limit each IP to 100 requests per windowMs
  message: 'Too many requests from this IP, please try again after 15 minutes'
});
app.use(limiter);

Custom Key Generator

This feature allows you to define a custom key generator function. The code sample demonstrates how to use the request IP address as the key for rate limiting.

const rateLimit = require('express-rate-limit');
const limiter = rateLimit({
  windowMs: 15 * 60 * 1000, // 15 minutes
  max: 100, // limit each IP to 100 requests per windowMs
  keyGenerator: (req, res) => req.ip // use the request IP address as the key
});
app.use(limiter);

Other packages similar to @types/express-rate-limit

express-slow-down

express-slow-down is a middleware for Express that slows down responses rather than blocking them when a user is making too many requests. This can be useful for deterring abuse while still allowing legitimate users to access the service, albeit at a slower rate.

rate-limiter-flexible

rate-limiter-flexible is a more flexible and powerful rate limiting library that supports various backends like Redis, MongoDB, and in-memory storage. It provides more advanced features compared to express-rate-limit, such as different rate limiting strategies and more granular control over rate limiting rules.

README

This is a stub types definition for @types/express-rate-limit (https://github.com/nfriedly/express-rate-limit).

express-rate-limit provides its own type definitions, so you don't need @types/express-rate-limit installed!