Class: RateLimitError

HTTP 429: the rate limit was exceeded.

Extends

APIError

Constructors

Constructor

new RateLimitError(
   status,
   body,
   headers,
   message?
): RateLimitError;

Parameters

status

number

body

unknown

headers

Headers

message?

string

Returns

RateLimitError

Inherited from

APIError.constructor

Properties

body

readonly body: unknown;

Parsed JSON, response text, or undefined for an empty body.

Inherited from

APIError.body

headers

readonly headers: Headers;

HTTP response headers.

Inherited from

APIError.headers

requestId

readonly requestId: string | undefined;

Request ID from x-typesafe-request-id, or undefined when absent.

Inherited from

APIError.requestId

retryAfterMs

readonly retryAfterMs: number | undefined;

Server retry delay in milliseconds, or undefined when absent or invalid.

status

readonly status: number;

HTTP response status code.

Inherited from

APIError.status

Methods

fromResponse()

static fromResponse(
   status,
   body,
   headers
): APIError;

Create the error subclass for an HTTP status code.

Parameters

status

number

body

unknown

headers

Headers

Returns

APIError

Inherited from

APIError.fromResponse