Skip to content
Shokupan

RateLimitOptions

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

Properties

Section titled “Properties”

headers?

Section titled “headers?”

optional headers: boolean

Defined in: src/plugins/middleware/rate-limit.ts:28

Whether to include X-RateLimit headers in the response

keyGenerator()?

Section titled “keyGenerator()?”

optional keyGenerator: (ctx) => string

Defined in: src/plugins/middleware/rate-limit.ts:34

Function to generate a unique key for each request This is used to identify the user or source of the request Defaults to the request’s ip address.

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/middleware/rate-limit.ts:16

Alias for max

max?

Section titled “max?”

optional max: number

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

Maximum number of requests allowed in the window

message?

Section titled “message?”

optional message: string | object | (ctx, key) => string | object

Defined in: src/plugins/middleware/rate-limit.ts:20

Message to send when rate limited

mode?

Section titled “mode?”

optional mode: "user" | "absolute"

Defined in: src/plugins/middleware/rate-limit.ts:48

Mode to use for rate limiting

  • user: Rate limit per user (generated key, defaults to ip address)
  • absolute: Rate limit for all users

onRateLimited()?

Section titled “onRateLimited()?”

optional onRateLimited: (ctx, key) => void | Response | Promise<void | Response>

Defined in: src/plugins/middleware/rate-limit.ts:38

Function to execute when a request is rate limited

Parameters

Section titled “Parameters”
ctx
Section titled “ctx”

ShokupanContext

key
Section titled “key”

string

Returns

Section titled “Returns”

void | Response | Promise<void | Response>

skip()?

Section titled “skip()?”

optional skip: (ctx) => boolean

Defined in: src/plugins/middleware/rate-limit.ts:42

Function to determine whether to skip rate limiting

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/middleware/rate-limit.ts:24

Status code to send when rate limited

trustedProxies?

Section titled “trustedProxies?”

optional trustedProxies: string[]

Defined in: src/plugins/middleware/rate-limit.ts:52

List of trusted proxy IPs

windowMs?

Section titled “windowMs?”

optional windowMs: number

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

Window in milliseconds