Class: GenericError

@ima/core.GenericError

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

Hierarchy

• Error

  ↳ GenericError

Constructors

constructor

• new GenericError(message, params?, dropInternalStackFrames?)

Initializes the generic IMA error.

Parameters

Name	Type	Default value	Description
message	string	undefined	The message describing the cause of the error.
params	Object	{}	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.
dropInternalStackFrames	boolean	true	Whether or not the call stack frames referring to the constructors of the custom errors should be excluded from the stack of this error (just like the native platform call stack frames are dropped by the JS engine). This flag is enabled by default.

Overrides

Error.constructor

Defined in

packages/core/src/error/GenericError.ts:26

Properties

_dropInternalStackFrames

• Protected _dropInternalStackFrames: boolean

Inherited from

Error._dropInternalStackFrames

Defined in

packages/core/src/error/ExtensibleError.ts:15

---

_params

• Protected _params: Object

Index signature

▪ [key: string]: unknown

Type declaration

Name	Type
status?	number

Defined in

packages/core/src/error/GenericError.ts:10

---

cause

• Optional cause: unknown

Inherited from

Error.cause

Defined in

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

---

message

• message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1054

---

name

• name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1053

---

prepareStackTrace

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

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

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:11

---

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:13

Accessors

stack

• get stack(): undefined | string

Returns

undefined | string

Inherited from

Error.stack

Defined in

packages/core/src/error/ExtensibleError.ts:17

Methods

getHttpStatus

▸ getHttpStatus(): number

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.

See

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

Returns

number

The HTTP status to send to the client.

Overrides

Error.getHttpStatus

Defined in

packages/core/src/error/GenericError.ts:38

---

getParams

▸ getParams(): Object

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.

See

Error#getHttpStatus

Returns

Object

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

Name	Type
status?	number

Overrides

Error.getParams

Defined in

packages/core/src/error/GenericError.ts:45

---

captureStackTrace

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:4