HTTP Error.

HttpError is a type of error class who've been thrown by the remote HTTP server.

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

Hierarchy

  • Error
    • HttpError

Constructors

  • Initializer Constructor.

    Parameters

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

      Method of the HTTP request.

    • path: string

      Path of the HTTP request.

    • status: number

      Status code from the remote HTTP server.

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

      Error message from the remote HTTP server.

    Returns HttpError

Properties

headers: Record<string, string | string[]>
message: string
method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE"
name: string
path: 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.

Methods

  • HttpError to JSON.

    When you call JSON.stringify() function on current HttpError instance, this HttpError.toJSON() method would be automatically called.

    Also, if response body from the remote HTTP server forms a JSON object, this HttpError.toJSON() method would be useful because it returns the parsed JSON object about the message property.

    Type Parameters

    • T

      Expected type of the response body.

    Returns HttpError.IProps<T>

    JSON object of the HttpError.

  • 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