Skip to content

RateLimitConfig

Configuration for the guard.rateLimit() middleware.

Properties

Section titled “Properties”

by?

Section titled “by?”

optional by?: "ip" | "sessionId"

Rate limit key. Default: “sessionId”.

maxPerMinute?

Section titled “maxPerMinute?”

optional maxPerMinute?: number

Maximum requests per minute. Default: 60.

message?

Section titled “message?”

optional message?: string

Custom message when onExceeded is “message”.

onExceeded?

Section titled “onExceeded?”

optional onExceeded?: "message" | "throw" | "skip"

Behavior when limit exceeded. Default: “message”.