Skip to content
Shokupan

RateLimitOptions

Defined in: src/plugins/rate-limit.ts:4

Properties

Section titled “Properties”

headers?

Section titled “headers?”

optional headers: boolean

Defined in: src/plugins/rate-limit.ts:10

keyGenerator()?

Section titled “keyGenerator()?”

optional keyGenerator: (ctx) => string

Defined in: src/plugins/rate-limit.ts:11

Parameters

Section titled “Parameters”
ctx
Section titled “ctx”

ShokupanContext

Returns

Section titled “Returns”

string

limit?

Section titled “limit?”

optional limit: number

Defined in: src/plugins/rate-limit.ts:7

max?

Section titled “max?”

optional max: number

Defined in: src/plugins/rate-limit.ts:6

message?

Section titled “message?”

optional message: string | object

Defined in: src/plugins/rate-limit.ts:8

mode?

Section titled “mode?”

optional mode: "user" | "absolute"

Defined in: src/plugins/rate-limit.ts:13

skip()?

Section titled “skip()?”

optional skip: (ctx) => boolean

Defined in: src/plugins/rate-limit.ts:12

Parameters

Section titled “Parameters”
ctx
Section titled “ctx”

ShokupanContext

Returns

Section titled “Returns”

boolean

statusCode?

Section titled “statusCode?”

optional statusCode: number

Defined in: src/plugins/rate-limit.ts:9

windowMs?

Section titled “windowMs?”

optional windowMs: number

Defined in: src/plugins/rate-limit.ts:5