Skip to main content
Version: 1.x

RateLimitLimiterConfig

RateLimitLimiterConfig​

@commandkit/ratelimittypes.ts

Core limiter configuration used by plugin and directives.

Signature
interface RateLimitLimiterConfig {
    maxRequests?: number;
    interval?: DurationLike;
    scope?: RateLimitScope | RateLimitScope[];
    algorithm?: RateLimitAlgorithmType;
    burst?: number;
    refillRate?: number;
    leakRate?: number;
    keyResolver?: RateLimitKeyResolver;
    keyPrefix?: string;
    storage?: RateLimitStorageConfig;
    violations?: ViolationOptions;
    queue?: RateLimitQueueOptions;
    windows?: RateLimitWindowConfig[];
    roleLimits?: Record<string, RateLimitLimiterConfig>;
    roleLimitStrategy?: RateLimitRoleLimitStrategy;
}

maxRequests​

property
number

interval​

property
DurationLike

scope​

property
RateLimitScope | RateLimitScope[]

algorithm​

property
RateLimitAlgorithmType

burst​

property
number

refillRate​

property
number

leakRate​

property
number

keyResolver​

property
RateLimitKeyResolver

keyPrefix​

property
string

storage​

property
RateLimitStorageConfig

violations​

property
ViolationOptions

queue​

property
RateLimitQueueOptions

windows​

property
RateLimitWindowConfig[]

roleLimits​

property
Record<string, RateLimitLimiterConfig>

roleLimitStrategy​

property
RateLimitRoleLimitStrategy