HTTPError

Defined in: src/http-api/errors.ts:36

Construct a generic HTTP error. This is a JavaScript Error with additional information specific to HTTP responses.

Param

msg

The error message to include.

Param

httpStatus

The HTTP response status code.

Param

httpHeaders

The HTTP response headers.

Extends

Error

Extended by

DigitalWorldError

Constructors

Constructor

new HTTPError(msg, httpStatus?, httpHeaders?): HTTPError

Defined in: src/http-api/errors.ts:37

Parameters

msg

string

httpStatus?

number

httpHeaders?

Headers

Returns

HTTPError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

httpHeaders?

readonly optional httpHeaders?: Headers

Defined in: src/http-api/errors.ts:40

httpStatus?

readonly optional httpStatus?: number

Defined in: src/http-api/errors.ts:39

message

message: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

name

name: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/globals.d.ts:68

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

getRetryAfterMs()

getRetryAfterMs(): number | null

Defined in: src/http-api/errors.ts:63

Returns

number | null

The recommended delay in milliseconds to wait before retrying the request that triggered this error, or null if no delay is recommended.

Throws

Error if the recommended delay is an invalid value.

See

safeGetRetryAfterMs for a version of this check that doesn’t throw.

isRateLimitError()

isRateLimitError(): boolean

Defined in: src/http-api/errors.ts:53

Check if this error was due to rate-limiting on the server side (and should therefore be retried after a delay).

If this returns true, getRetryAfterMs can be called to retrieve the server-side recommendation for the retry period.

Returns

boolean

Whether this error is due to rate-limiting.

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/globals.d.ts:52

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

Defined in: node_modules/.pnpm/@types+node@22.20.0/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace