Class HttpError

Represents an HTTP-related error.

Remarks

This error is thrown whenever an HTTP request encounters a non-successful HTTP status code. It includes detailed information about the request, including the status code, status text, URL, HTTP method, and response body.

The HttpError class masks lengthy non-JSON response bodies for readability in the error message.

Hierarchy

  • CustomError
    • HttpError

Properties

cause? message stack? prepareStackTrace? stackTraceLimit

Accessors

body method name status statusText url

Methods

captureStackTrace

Properties

Optionalcause

cause?: unknown

message

message: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

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

Optional override for formatting stack traces

See

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

StaticstackTraceLimit

stackTraceLimit: number

Accessors

body

  • get body(): string

    The response body of the request.

    Returns string

    Remarks

    If the response body was excessively long (and not JSON), it might be truncated in the error message for readability. Use this property to access the full response body if needed.

method

name

  • get name(): string

    Returns string

status

statusText

url

Methods

StaticcaptureStackTrace

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

    Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Properties
Accessors
Methods