Documentation
    Preparing search index...

    Error thrown when HTTP request fails with non-2xx status.

    HttpError is thrown by HttpLlm.execute and HttpMigration.execute when the server returns a non-2xx status code. Contains the full HTTP context: method, path, status, headers, and response body.

    The response body is available via message (raw string) or toJSON (parsed JSON). For non-throwing behavior, use HttpLlm.propagate or HttpMigration.propagate instead.

    Jeongho Nam - https://github.com/samchon

    Hierarchy

    • Error
      • HttpError
    Index

    Constructors

    • Parameters

      • method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "QUERY"

        HTTP method

      • path: string

        Request path or URL

      • status: number

        HTTP status code

      • headers: Record<string, string | string[]>

        Response headers

      • message: string

        Error message (response body)

      Returns HttpError

    Properties

    cause?: unknown
    headers: Record<string, string | string[]>

    Response headers from server.

    message: string
    method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "QUERY"

    HTTP method used for the request.

    name: string
    path: string

    Request path or URL.

    stack?: string
    status: number

    HTTP status code from server.

    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

    • Serialize to JSON-compatible object.

      Lazily parses JSON message body on first call. If parsing fails, returns the original string.

      Type Parameters

      • T

        Expected response body type

      Returns HttpError.IProps<T>

      Structured HTTP error information

    • 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

    • Indicates whether the argument provided is a built-in Error instance or not.

      Parameters

      • error: unknown

      Returns error is Error

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any