Skip to content

Class: APIError

An unsuccessful HTTP response from the API.

Extends

Extended by

Constructors

Constructor

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

Parameters

status

number

body

unknown

headers

Headers

message?

string

Returns

APIError

Overrides

TypeSafeError.constructor

Properties

body

readonly body: unknown;

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

headers

readonly headers: Headers;

HTTP response headers.

requestId

readonly requestId: string | undefined;

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

status

readonly status: number;

HTTP response status code.

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