Type Alias RateLimitOptions<T>

Configuration options for rate limiting behavior when creating a new bucket.

type RateLimitOptions<T extends Func> = {
    maxCalls: number;
    onLimitReached?: (
        error: RateLimitError,
        nextAvailable: Date,
        args: Parameters<T>,
    ) => void | Promise<void>;
    throws?: boolean;
    windowMs?: number;
}

Properties

maxCalls: number

Maximum number of calls allowed within the time window

onLimitReached?: (
    error: RateLimitError,
    nextAvailable: Date,
    args: Parameters<T>,
) => void | Promise<void>

Callback invoked when rate limit is exceeded

throws?: boolean

Whether to throw an error when limit is exceeded (default: true)

windowMs?: number

Time window in milliseconds for rate limiting (default: 1000)