Setu-TS
    Preparing search index...

    Class HttpClientError<TBody>

    Thrown by IHttpClient.request() when the server returns a non-2xx status.

    TBody is the parsed error payload. It defaults to unknown, so the bare name HttpClientError keeps meaning exactly what it did and every existing catch (e) { if (e instanceof HttpClientError) … } is unaffected. A generated client narrows it through its own per-operation error guard, which is how a document's declared 4xx schemas reach the caller — the throw site itself cannot know which operation it is serving.

    0.1.0

    Type Parameters

    • TBody = unknown

      The parsed error response body.

    Hierarchy

    • Error
      • HttpClientError
    Index
    body: TBody
    cause?: unknown
    headers: Headers
    message: string
    name: string
    stack?: string
    status: number
    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.

    • 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