Class: ApiError

Thrown by the client for any non-2xx response. status is the HTTP status; requestId is the API's id for the failed request (from the error body, else the x-request-id header), to quote when reporting a problem.

Extends

• Error

Constructors

Constructor

new ApiError(
   message, 
   status, 
   code, 
   details?, 
   requestId?
): ApiError;

Parameters

message

string

status

number

code

string

details?

unknown

requestId?

string

Returns

ApiError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown;

Inherited from

Error.cause

---

code

readonly code: string;

---

details?

readonly optional details?: unknown;

---

message

message: string;

Inherited from

Error.message

---

name

name: string;

Inherited from

Error.name

---

requestId?

readonly optional requestId?: string;

---

stack?

optional stack?: string;

Inherited from

Error.stack

---

status

readonly status: number;

---

stackTraceLimit

static stackTraceLimit: number;

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

---

fromResponse()

static fromResponse(
   status, 
   statusText, 
   body, 
   headers?
): ApiError;

Builds an ApiError from a response status and its (possibly non-JSON) body. headers are the response headers, used for the request id when the body carries none.

Parameters

status

number

statusText

string

body

unknown

headers?

Pick<Headers, "get"> | null

Returns

ApiError

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace