RateLimitOptions
Defined in: src/plugins/rate-limit.ts:4
Properties
Section titled “Properties”headers?
Section titled “headers?”
optionalheaders:boolean
Defined in: src/plugins/rate-limit.ts:10
keyGenerator()?
Section titled “keyGenerator()?”
optionalkeyGenerator: (ctx) =>string
Defined in: src/plugins/rate-limit.ts:11
Parameters
Section titled “Parameters”Returns
Section titled “Returns”string
limit?
Section titled “limit?”
optionallimit:number
Defined in: src/plugins/rate-limit.ts:7
optionalmax:number
Defined in: src/plugins/rate-limit.ts:6
message?
Section titled “message?”
optionalmessage:string|object
Defined in: src/plugins/rate-limit.ts:8
optionalmode:"user"|"absolute"
Defined in: src/plugins/rate-limit.ts:13
skip()?
Section titled “skip()?”
optionalskip: (ctx) =>boolean
Defined in: src/plugins/rate-limit.ts:12
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
statusCode?
Section titled “statusCode?”
optionalstatusCode:number
Defined in: src/plugins/rate-limit.ts:9
windowMs?
Section titled “windowMs?”
optionalwindowMs:number
Defined in: src/plugins/rate-limit.ts:5