RateLimitError

Class in Errors · JavaScript & TypeScript

Discovery HTTP or the gateway imposed a connection rate limit

When retryAfterMs is available, wait at least that duration before another manual attempt

class RateLimitError extends FluxerlyErrorclass RateLimitError
  extends FluxerlyError

Constructor#

new RateLimitError(
    source: "gateway" | "http",
    retryAfterMs: number | null
): RateLimitErrornew RateLimitError(
  source: "gateway" | "http",
  retryAfterMs: number | null
): RateLimitError

Parameters

source: Whether discovery HTTP or the gateway imposed the limit
"gateway" | "http"
retryAfterMs: Server-required wait in milliseconds, or null when no usable duration was supplied
number | null

Properties#

`_tag`#

Discriminator for identifying a connection rate limit

readonly _tag: "RateLimitError"

`retryAfterMs`#

Server-required wait in milliseconds, or null when no usable duration was supplied

readonly retryAfterMs: number | nullreadonly retryAfterMs:
  | number | null

`source`#

Whether discovery HTTP or the gateway imposed the limit

readonly source: "gateway" | "http"

Inherited#

Inherited from FluxerlyError: code, details, hint, toJSON