rateLimit
rateLimit(
options?):Function
Defined in: http/rate-limit.js:40
Create a rate limiting middleware.
Parameters
Section titled “Parameters”options?
Section titled “options?”keyGenerator?
Section titled “keyGenerator?”Function
(req) => string client identifier (default: remote IP)
number = 100
Maximum requests per window
store?
Section titled “store?”any
Pluggable store (must implement hit(key, windowMs))
windowMs?
Section titled “windowMs?”number = 60000
Window size in milliseconds (default: 1 minute)
Returns
Section titled “Returns”Function
- Middleware
(req) => {response}that returns rate-limit header tuples on allowed requests and{response: {statusCode: 429, retryAfter}}when the limit is exceeded