Skip to main content
Version: 1.x

RateLimitResult

RateLimitResult

Result for a single limiter/window evaluation used for aggregation.

Signature
interface RateLimitResult {
key: string;
scope: RateLimitScope;
algorithm: RateLimitAlgorithmType;
windowId?: string;
limited: boolean;
remaining: number;
resetAt: number;
retryAfter: number;
limit: number;
}

key

property
string

scope

algorithm

windowId

property
string

limited

property
boolean

remaining

property
number

resetAt

property
number

retryAfter

property
number

limit

property
number