HttpError

Source: HttpClient.ts:111

HTTP error class

Remarks

Thrown when an HTTP request fails. Contains detailed information about the failure.

Example

try {
  await httpClient.get('/api/users')
} catch (error) {
  if (error instanceof HttpError) {
    console.log(`Request failed: ${error.status} - ${error.message}`)
  }
}

Constructors

new HttpError( message: string, status: number, url: string, config: RequestConfig, data?: unknown, ): HttpError

Parameters

• message (string) — Error message
• status (number) — HTTP status code
• url (string) — Request URL
• config (RequestConfig) — Request configuration
• data (unknown, optional) — Response data if available

Returns

HttpError

Hierarchy

• Error
• HttpError

Properties

config: RequestConfig

Request configuration that caused the error

data: unknown

Response data if available

message: string

Inherited from message

name: string

Inherited from name

stack: string

Inherited from stack

status: number

HTTP status code

url: string

Request URL

Methods

isClientError(): boolean

Checks if error is a client error (4xx)

Returns

• boolean

isServerError(): boolean

Checks if error is a server error (5xx)

Returns

• boolean

Static Properties

stackTraceLimit: number

Inherited from stackTraceLimit

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.

Static Methods

captureStackTrace( targetObject: object, constructorOpt?: Function, ): void

Inherited from captureStackTrace

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, optional)

Returns

• void

prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Inherited from prepareStackTrace

Parameters

• err (Error)
• stackTraces (CallSite[])

Returns

• any

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