Skip to main content
Version: 1.x

RateLimitPluginOptions

RateLimitPluginOptions​

@commandkit/ratelimittypes.ts

Runtime plugin options consumed by RateLimitPlugin. Configure these via configureRatelimit().

Signature
interface RateLimitPluginOptions {
    defaultLimiter?: RateLimitLimiterConfig;
    limiters?: Record<string, RateLimitLimiterConfig>;
    storage?: RateLimitStorageConfig;
    keyPrefix?: string;
    keyResolver?: RateLimitKeyResolver;
    bypass?: RateLimitBypassOptions;
    hooks?: RateLimitHooks;
    onRateLimited?: RateLimitResponseHandler;
    queue?: RateLimitQueueOptions;
    roleLimits?: Record<string, RateLimitLimiterConfig>;
    roleLimitStrategy?: RateLimitRoleLimitStrategy;
    initializeDefaultStorage?: boolean;
    initializeDefaultDriver?: boolean;
}

defaultLimiter​

property
RateLimitLimiterConfig

limiters​

property
Record<string, RateLimitLimiterConfig>

storage​

property
RateLimitStorageConfig

keyPrefix​

property
string

keyResolver​

property
RateLimitKeyResolver

bypass​

property
RateLimitBypassOptions

hooks​

property
RateLimitHooks

onRateLimited​

property
RateLimitResponseHandler

queue​

property
RateLimitQueueOptions

roleLimits​

property
Record<string, RateLimitLimiterConfig>

roleLimitStrategy​

property
RateLimitRoleLimitStrategy

initializeDefaultStorage​

property
boolean
default:
true

Whether to initialize the default in-memory storage if no storage is configured.

initializeDefaultDriver​

property
boolean
default:
true

Alias for initializeDefaultStorage, aligned with other packages.