Class HttpError

constructor

• new HttpError(
      method: "GET" | "DELETE" | "POST" | "PUT" | "PATCH" | "HEAD",
      path: string,
      status: number,
      headers: Record<string, string | string[]>,
      message: string,
  ): HttpError

  Initializer Constructor.

  Parameters

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

    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

Readonlyheaders

Readonlymethod

Readonlypath

Readonlystatus

toJSON

• toJSON<T>(): HttpError.IProps<T>

  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.