DataApiError

The server answered with a non-success status, or the request was refused before it was sent.

Extends

• Error

Constructors

Constructor

new DataApiError(status, code, message, requestId?, retryAfterSeconds?, local?): DataApiError

Parameters

status

number

code

string

message

string

requestId?

string | null

retryAfterSeconds?

number | null

local?

boolean = false

Returns

DataApiError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Inherited from

Error.cause

---

code

readonly code: string

The server’s error code (field_not_queryable, invalid_cursor, …), or unauthorized / error when the body carried none.

---

local

readonly local: boolean

True when this client refused the request itself, before any network call.

---

message

message: string

Inherited from

Error.message

---

name

readonly name: "DataApiError" = 'DataApiError'

Overrides

Error.name

---

requestId

readonly requestId: string | null

The X-Request-Id to quote to support, or null when the request never reached the server.

---

retryAfterSeconds

readonly retryAfterSeconds: number | null

From Retry-After on a 429.

---

stack?

optional stack?: string

Inherited from

Error.stack

---

status

readonly status: number

The HTTP status; 400 for a request this client refused to send.

---

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

---

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