ContentDeliveryError

A non-2xx response from the Content Delivery API. status and code (the body’s error string — null when the body wasn’t the documented JSON shape, e.g. an HTML page from a proxy) let a caller branch on the documented failures rather than parse prose: missing_api_key/invalid_api_key (401), scope_denied/origin_denied/ip_denied/ app_not_available (403), payment_required (402), path_not_found/not_published (404), invalid_context/unknown_category/validation_failed (400), quota_exceeded/ too_many_failed_authentications (429 — retryAfterSeconds is set).

requestId is the request’s reference: the X-Request-Id response header, else the body’s requestId (an unhandled 500 carries it there too), else null — as it is for a response something in front of the API generated, which never reached it. Quote it to support; it is how that request is found in the logs.

Extends

• Error

Constructors

Constructor

new ContentDeliveryError(status, body, retryAfterSeconds?, requestId?): ContentDeliveryError

Parameters

status

number

body

unknown

retryAfterSeconds?

number | null

requestId?

string | null

Returns

ContentDeliveryError

Overrides

Error.constructor

Properties

body

readonly body: unknown

---

cause?

optional cause?: unknown

Inherited from

Error.cause

---

code

readonly code: string | null

---

message

message: string

Inherited from

Error.message

---

name

name: string

Inherited from

Error.name

---

requestId

readonly requestId: string | null

---

retryAfterSeconds

readonly retryAfterSeconds: number | null

---

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

---

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