DropInApiError

Extends

• Error

Constructors

Constructor

new DropInApiError(
   code,
   message,
   status,
   requestId,
   retryAfterSeconds?,
   fields?,
   url?): DropInApiError;

Parameters

Parameter	Type	Description
code	ErrorCode	-
message	string	-
status	number	-
requestId	string	-
retryAfterSeconds?	number	Seconds to wait before retrying, from the response’s Retry-After header. Set on RATE_LIMITED (429) and absent otherwise. Sleep this long rather than retrying in a tight loop — a tight loop is itself what the limit is defending against.
fields?	ApiFieldError[]	Per-field detail on a VALIDATION_FAILED, when the API sent any: path is the field it rejected, message says why. Absent on every other code.
url?	string	The request URL that failed, when the runtime gave us one (Response.url). The message deliberately carries only what the API said, so this is what tells a backend log WHICH call failed — an error surfacing from a job that touches six routes is otherwise just “Not found”.

Returns

DropInApiError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown;

Inherited from

Error.cause

---

code

readonly code: ErrorCode;

---

fields?

readonly optional fields?: ApiFieldError[];

Per-field detail on a VALIDATION_FAILED, when the API sent any: path is the field it rejected, message says why. Absent on every other code.

---

message

message: string;

Inherited from

Error.message

---

name

name: string;

Inherited from

Error.name

---

requestId

readonly requestId: string;

---

retryAfterSeconds?

readonly optional retryAfterSeconds?: number;

Seconds to wait before retrying, from the response’s Retry-After header. Set on RATE_LIMITED (429) and absent otherwise. Sleep this long rather than retrying in a tight loop — a tight loop is itself what the limit is defending against.

---

stack?

optional stack?: string;

Inherited from

Error.stack

---

status

readonly status: number;

---

url?

readonly optional url?: string;

The request URL that failed, when the runtime gave us one (Response.url). The message deliberately carries only what the API said, so this is what tells a backend log WHICH call failed — an error surfacing from a job that touches six routes is otherwise just “Not found”.

---

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

[hasInstance]()

static hasInstance: boolean;

Parameters

Parameter	Type
this	unknown
value	unknown

Returns

boolean

---

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace