Class HttpError<T>

Throw this error to return an HTTP error response.

Warning

This error should is caught by the framework and sent as an HTTP response. The message therefore should not contain any sensitive information!

Type Parameters

T extends number = number

Hierarchy

Error
- HttpError

Index

Constructors

Properties

message name stack? status prepareStackTrace? stackTraceLimit

Methods

toJson captureStackTrace

Constructors

constructor

new HttpError<T>(status, message): HttpError<T>
Type Parameters
- T extends number = number
Parameters
- status: T
- message: string
Returns HttpError<T>
Overrides Error.constructor
- Defined in packages/core/basic/src/error.ts:9

Properties

message

message: string

name

name: string

`Optional` stack

stack?: string

`Readonly` status

status: T

`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

Methods

toJson

toJson(): {
message: string;
status: T;
}
Get a json representation of the error.

Returns {
message: string;
status: T;
}
the json representation of the error
- message: string
- status: T
- Defined in packages/core/basic/src/error.ts:18

`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/@types/node/globals.d.ts:4

Generated using TypeDoc