GenericRateLimitOptions
Defined in: types.ts:218
Generic rate limit options
Properties
Section titled “Properties”handler?
Section titled “handler?”
optionalhandler:GenericRateLimitHandler
Defined in: types.ts:237
Handler called when rate limit exceeded
headers?
Section titled “headers?”
optionalheaders:boolean
Defined in: types.ts:247
Custom headers to include in rate limit responses
keyGenerator?
Section titled “keyGenerator?”
optionalkeyGenerator:GenericRateLimitKeyGenerator
Defined in: types.ts:232
Generate rate limit key from request (default: IP address)
max:
number
Defined in: types.ts:222
Maximum number of requests per window
skip()?
Section titled “skip()?”
optionalskip: (req) =>boolean|Promise<boolean>
Defined in: types.ts:242
Skip rate limiting for certain requests
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean | Promise<boolean>
windowMs?
Section titled “windowMs?”
optionalwindowMs:number
Defined in: types.ts:227
Time window in milliseconds (default: 60000 = 1 minute)