index/classes/NetworkError.md

Error thrown when network operations fail

This error is used for HTTP request failures, API communication errors, and network connectivity issues. It captures the HTTP status code, the server's answer (NetworkErrorServerAnswer: serverMessage, serverError, details, body) and the original error for debugging.

Wrapping keeps the answer: a NetworkError made from an axios error reads its response, and one made from another NetworkError (a service adding its context to the HTTP client's error) takes that error's answer. handleNetworkError (the withErrorHandling wrap) also takes its status.

Examples

HTTP request failure

throw new NetworkError(
  'Failed to fetch pool data',
  404,
  originalError
);

Showing the backend's own text

try {
  await sdk.updateProfile({ fullName: 'x' });
} catch (error) {
  if (error instanceof NetworkError) {
    toast(error.serverMessage ?? 'Something went wrong');
    if (error.statusCode === 404) console.log('Resource not found');
  }
}

Extends

• Error

Constructors

Constructor

new NetworkError(message, statusCode?, originalError?, answer?): NetworkError

Creates a new NetworkError

Parameters

Parameter	Type	Description
message	string	Human-readable error message describing what failed
statusCode?	number	Optional HTTP status code (404, 500, etc.)
originalError?	Error	Optional original error that caused this failure
answer?	NetworkErrorServerAnswer	The server's answer; default the one behind originalError

Returns

NetworkError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from
body?	readonly	unknown	The whole response body. Since 9.0.0	-
details?	readonly	unknown	The body's details. Since 9.0.0	-
message	public	string	-	Error.message
name	public	string	-	Error.name
originalError?	public	Error	The error this one wraps (an axios error, or the NetworkError of the HTTP client).	-
serverError?	readonly	string	The body's error when it is a string. Since 9.0.0	-
serverMessage?	readonly	string	The body's message (see NetworkErrorServerAnswer.serverMessage). Since 9.0.0	-
stack?	public	string	-	Error.stack
statusCode?	public	number	The HTTP status (404, 500, ...), when known.	-
stackTraceLimit	static	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.	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

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