Skip to content
ai.matey

RateLimitOptions

Defined in: types.ts:364

Rate limiting configuration (Node.js-specific)

Properties

Section titled “Properties”

handler?

Section titled “handler?”

optional handler: RateLimitHandler

Defined in: types.ts:383

Handler called when rate limit exceeded

headers?

Section titled “headers?”

optional headers: boolean

Defined in: types.ts:393

Custom headers to include in rate limit responses

keyGenerator?

Section titled “keyGenerator?”

optional keyGenerator: RateLimitKeyGenerator

Defined in: types.ts:378

Generate rate limit key from request (default: IP address)

max

Section titled “max”

max: number

Defined in: types.ts:368

Maximum number of requests per window

skip()?

Section titled “skip()?”

optional skip: (req) => boolean | Promise<boolean>

Defined in: types.ts:388

Skip rate limiting for certain requests

Parameters

Section titled “Parameters”
req
Section titled “req”

IncomingMessage

Returns

Section titled “Returns”

boolean | Promise<boolean>

windowMs?

Section titled “windowMs?”

optional windowMs: number

Defined in: types.ts:373

Time window in milliseconds (default: 60000 = 1 minute)