Member Junction
    Preparing search index...

    Class HttpError

    Thrown for a non-2xx response (when ThrowOnError is on), a timeout, a caller-initiated cancellation, or a transport failure.

    Unlike axios's error — which nests response details under error.response and leaves you guessing whether that property exists — every field here is always present. A request that never reached a server reports Status: 0, so error.Status === 404 is safe to write without an optional-chain dance.

    Distinguish the three failure modes with Status, HttpError.IsTimeout, and HttpError.IsCancelled.

    try {
        await client.Get('/thing');
    } catch (error) {
        if (!IsHttpError(error)) throw error;
        if (error.IsCancelled) return;                       // caller aborted; not a failure
        if (error.IsTimeout) LogError('upstream slow');
        else if (error.Status === 404) LogError('missing');
        else if (error.Status === 429) await backOff(error.Headers['retry-after']);
        else LogError(`HTTP ${error.Status}`, error.Data);
    }

    Hierarchy

    • Error
      • HttpError
    Index

    Constructors

    constructor

    Properties

    cause? Data Headers IsCancelled IsTimeout message Method name stack? Status StatusText Url stackTraceLimit

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    • Parameters

      • message: string
      • details: {
            Data?: unknown;
            Headers?: Record<string, string>;
            IsCancelled?: boolean;
            IsTimeout?: boolean;
            Method: HttpMethod;
            Status?: number;
            StatusText?: string;
            Url: string;
        }

      Returns HttpError

    Properties

    cause?: unknown
    Data: unknown

    Parsed response body, when one was received.

    Headers: Record<string, string>

    Response headers, lower-cased keys. Empty when there was no response.

    IsCancelled: boolean

    True when the caller's own Signal aborted the request — the axios.isCancel equivalent.

    IsTimeout: boolean

    True when the failure was this request's own Timeout elapsing.

    message: string
    Method: HttpMethod

    The HTTP method used.

    name: string
    stack?: string
    Status: number

    HTTP status code, or 0 when the request never produced a response (timeout / network error).

    StatusText: string

    HTTP status text, empty when there was no response.

    Url: string

    The URL that was requested.

    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.

    Methods

    • 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
      • OptionalconstructorOpt: Function

      Returns void

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods