Skip to main content

Class: GenericError<T>

Defined in: packages/core/src/error/GenericError.ts:15

Implementation of the Error interface, providing more advanced error API.

Extends​

Extended by​

Type Parameters​

• T = unknown

Constructors​

new GenericError()​

new GenericError<T>(message, params?): GenericError<T>

Defined in: packages/core/src/error/GenericError.ts:27

Initializes the generic IMA error.

Parameters​

message​

string

The message describing the cause of the error.

params?​

T & GenericErrorParams

A data map providing additional details related to the error. It is recommended to set the status field to the HTTP response code that should be sent to the client.

Returns​

GenericError<T>

Overrides​

Error.constructor

Properties​

_params​

protected _params: T & GenericErrorParams

Defined in: packages/core/src/error/GenericError.ts:16

cause?​

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from​

Error.cause

message​

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

Error.message

name​

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

Error.name

stack?​

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

Error.stack

prepareStackTrace()?​

static optional prepareStackTrace: (err, stackTraces) => any

Defined in: node_modules/@types/node/globals.d.ts:98

Optional override for formatting stack traces

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from​

Error.prepareStackTrace

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:100

Inherited from​

Error.stackTraceLimit

Methods​

getHttpStatus()​

getHttpStatus(): number

Defined in: packages/core/src/error/GenericError.ts:39

Returns the HTTP status to send to the client.

If the error has occurred at the client-side, the status code is used to determine the error page to show to the user.

This method is a shorthand for the following code snippet: this.getParams().status || 500.

Returns​

number

The HTTP status to send to the client.

See​

http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

Overrides​

Error.getHttpStatus

getParams()​

getParams(): T & GenericErrorParams

Defined in: packages/core/src/error/GenericError.ts:46

Returns the error parameters providing additional details about the error. The structure of the returned object is always situation-dependent, but the returned object usually contains the status: number field which represents the HTTP status to send to the client.

Returns​

T & GenericErrorParams

The route parameters of the route at which the error has occurred.

See​

Error#getHttpStatus

Overrides​

Error.getParams

isClientError()​

isClientError(): boolean

Defined in: packages/core/src/error/GenericError.ts:53

Tests, whether the specified error was caused by the client's action (for example wrong URL or request encoding).

Returns​

boolean

true if the error was caused the action of the client.

Overrides​

Error.isClientError

isRedirection()​

isRedirection(): boolean

Defined in: packages/core/src/error/GenericError.ts:60

Tests, whether the specified error should lead to a redirect.

Returns​

boolean

true if the error should cause a redirect.

Overrides​

Error.isRedirection

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:91

Create .stack property on a target object

Parameters​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

Error.captureStackTrace