ReferenceClasses
RateLimitError
Defined in: packages/client/src/errors.ts:154
Thrown when a fixed outbound limit is reached: CHANNEL_SEND_LIMIT parts per CHANNEL_SEND_WINDOW_MS on
one channel, or one flood advert per ADVERT_FLOOD_INTERVAL_MS. Nothing is queued: retry after retryAfterMs.
Extends
Constructors
Constructor
new RateLimitError(
resource,
channel,
limit,
windowMs,
retryAfterMs
): RateLimitError;Defined in: packages/client/src/errors.ts:168
Parameters
resource
channel or advert
channel
Channel | null
The channel, when resource is channel
limit
number
Sends allowed per window
windowMs
number
Sliding window
retryAfterMs
number
Delay before one send is allowed again
Returns
RateLimitError
Overrides
Properties
channel
readonly channel: Channel | null;Defined in: packages/client/src/errors.ts:156
code
readonly code: string;Defined in: packages/transports/src/errors.ts:3
Inherited from
limit
readonly limit: number;Defined in: packages/client/src/errors.ts:157
resource
readonly resource: RateLimitedResource;Defined in: packages/client/src/errors.ts:155
retryAfterMs
readonly retryAfterMs: number;Defined in: packages/client/src/errors.ts:159
windowMs
readonly windowMs: number;Defined in: packages/client/src/errors.ts:158