Skip to main content
Version: 1.x

RateLimitError

RateLimitError​

@commandkit/ratelimiterrors.ts

Error thrown by the directive wrapper when a function is rate-limited.

Signature
class RateLimitError extends Error {
    public readonly result: RateLimitStoreValue;
    constructor(result: RateLimitStoreValue, message?: string)
}
  • Extends: Error

result​

property
RateLimitStoreValue

constructor​

method
(result: RateLimitStoreValue, message?: string) => RateLimitError

Create a rate-limit error with the stored result payload.