Skip to main content
Version: 1.x

RateLimitHooks

RateLimitHooks​

@commandkit/ratelimittypes.ts

Optional lifecycle hooks used by the plugin to surface rate limit events.

Signature
interface RateLimitHooks {
    onRateLimited?: (info: RateLimitHookContext) => void | Promise<void>;
    onAllowed?: (info: RateLimitHookContext) => void | Promise<void>;
    onReset?: (key: string) => void | Promise<void>;
    onViolation?: (key: string, count: number) => void | Promise<void>;
    onStorageError?: (
    error: unknown,
    fallbackUsed: boolean,
  ) => void | Promise<void>;
}

onRateLimited​

property
(info: RateLimitHookContext) => void | Promise<void>

onAllowed​

property
(info: RateLimitHookContext) => void | Promise<void>

onReset​

property
(key: string) => void | Promise<void>

onViolation​

property
(key: string, count: number) => void | Promise<void>

onStorageError​

property
( error: unknown, fallbackUsed: boolean, ) => void | Promise<void>