Skip to main content
Version: 1.x

ResolvedLimiterConfig

ResolvedLimiterConfig​

@commandkit/ratelimittypes.ts

Limiter configuration after defaults are applied.

Signature
interface ResolvedLimiterConfig {
    maxRequests: number;
    intervalMs: number;
    algorithm: RateLimitAlgorithmType;
    scope: RateLimitScope;
    burst: number;
    refillRate: number;
    leakRate: number;
    violations?: ViolationOptions;
    windowId?: string;
}

maxRequests​

property
number

intervalMs​

property
number

algorithm​

property
RateLimitAlgorithmType

scope​

property
RateLimitScope

burst​

property
number

refillRate​

property
number

leakRate​

property
number

violations​

property
ViolationOptions

windowId​

property
string