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
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

stackTraceLimit: number

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.

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void