Class HttpError

Class representing an HttpError.

Author

Mr. Stone evensstone@gmail.com

Hierarchy

RuntimeError
- HttpError

Index

Constructors

Properties

cause? code? headers metadata? statusCode statusMessage

Methods

toString create

Constructors

constructor

new HttpError(
    message: string,
    statusCode?: number,
    headers?: HeadersType,
    options?: ErrorOptions,
): HttpError
Create an HttpError.
Parameters
- message: string
  The message to log.
- statusCode: number = 500
- headers: HeadersType = ...
- options: ErrorOptions = {}
  The error options.
Returns HttpError

Overrides RuntimeError.constructor

Properties

`Optional` `Readonly`cause

cause?: Error

`Optional` `Readonly`code

code?: string

`Readonly`headers

headers: HeadersType

`Optional` `Readonly`metadata

metadata?: unknown

`Readonly`statusCode

statusCode: number

`Readonly`statusMessage

statusMessage: string

Methods

toString

toString(multiline?: boolean): string
Converts the error to a formatted string representation.
Parameters
- Optionalmultiline: boolean
  Determine if output value must be multiline or not.
Returns string
A formatted error string.

Inherited from RuntimeError.toString

`Static`create

create<T extends RuntimeError = RuntimeError>(
message: string,
options?: ErrorOptions,
): T
Create a RuntimeError.
Type Parameters
- T extends RuntimeError = RuntimeError
Parameters
- message: string
- Optionaloptions: ErrorOptions
  The options to create a RuntimeError.
Returns T
A new RuntimeError instance.

Inherited from RuntimeError.create