Class HttpError

A error corresponding to the given HTTP status code.

HTTP request processing handlers may raise this error. The error handler would render corresponding error page then.

See

HttpConfig.errorHandler

Hierarchy

Error
- HttpError

Implements

Loggable

Index

Constructors

Properties

prepareStackTrace? stackTraceLimit cause? message name stack?

Accessors

details statusCode statusMessage

Methods

captureStackTrace toLog

Constructors

constructor

new HttpError(statusCode, options?): HttpError
Constructs HTTP status error.
Parameters
- statusCode: number
  
  HTTP status code.
- options: Options = {}
  
  HTTP error options.
Returns HttpError
Overrides Error.constructor
- Defined in hatsy/hatsy/src/http/http-error.ts:23

Properties

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

- (err, stackTraces): any
- Optional override for formatting stack traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static` stackTraceLimit

stackTraceLimit: number

`Optional` cause

cause?: unknown

message

message: string

name

name: string

`Optional` stack

stack?: string

Accessors

details

get details(): undefined | string
Error details.

This will be displayed on error page in addition to error code.

Returns undefined | string
- Defined in hatsy/hatsy/src/http/http-error.ts:50

statusCode

get statusCode(): number
HTTP status code.

Returns number
- Defined in hatsy/hatsy/src/http/http-error.ts:34

statusMessage

get statusMessage(): undefined | string
HTTP status message.

Returns undefined | string
- Defined in hatsy/hatsy/src/http/http-error.ts:41

Methods

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/.pnpm/@types+node@18.17.17/node_modules/@types/node/globals.d.ts:4

toLog

toLog(__namedParameters): void | unknown[]
Performs additional message processing before it is logged.

At output or default logging stage replaces this error with error message, details, and reason. Does nothing at other logging stages.
Parameters
- __namedParameters: DueLog
Returns void | unknown[]
Either new loggable value representation, or nothing outside the output logging stage.
Implementation of Loggable.toLog
- Defined in hatsy/hatsy/src/http/http-error.ts:62

Generated using TypeDoc