Class: HttpNetworkError

Thrown by ctx.http (and so by fetch) for a request that failed in transit, after the host handed it to the network; network says how far it got (HttpNetwork). A request the host refuses (a host the install did not approve, a missing secret, a limit reached) throws a plain AppError instead. Like those it is final unless the app decides otherwise: a request that was not_sent never reached the vendor, so sending it again is always safe, while after unknown it is safe only for a request the vendor treats as idempotent. Catch it and throw an AppError with retryable: true when another attempt should be made.

Extends

• AppError

Constructors

Constructor

new HttpNetworkError(
   message, 
   network, 
   options?
): HttpNetworkError;

Parameters

message

string

network

HttpNetwork

options?

AppErrorOptions = {}

Returns

HttpNetworkError

Overrides

AppError.constructor

Properties

cause?

optional cause?: unknown;

Inherited from

AppError.cause

---

message

message: string;

Inherited from

AppError.message

---

name

name: string;

Inherited from

AppError.name

---

network

readonly network: HttpNetwork;

---

options

readonly options: AppErrorOptions = {};

Inherited from

AppError.options

---

stack?

optional stack?: string;

Inherited from

AppError.stack

---

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

AppError.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

AppError.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

AppError.prepareStackTrace