Skip to main content

Abstract Class: Error

Defined in: packages/core/src/error/Error.ts:7

The IMA application error extends the native Error with additional details that lead to the error and the HTTP status code to send to the client.

Extends​

  • Error

Extended by​

Constructors​

Constructor​

new Error(message, params?): IMAError

Defined in: packages/core/src/error/Error.ts:8

Parameters​

message​

string

params?​
cause?​

string | Error

Returns​

IMAError

Overrides​

Error.constructor

Properties​

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

stackTraceLimit​

static stackTraceLimit: number

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

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from​

Error.stackTraceLimit

Methods​

getHttpStatus()​

getHttpStatus(): number

Defined in: packages/core/src/error/Error.ts:24

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

getParams()​

getParams(): UnknownParameters

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

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​

UnknownParameters

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

See​

Error#getHttpStatus

isClientError()​

isClientError(): boolean

Defined in: packages/core/src/error/Error.ts:50

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.

isRedirection()​

isRedirection(): boolean

Defined in: packages/core/src/error/Error.ts:59

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

Returns​

boolean

true if the error should cause a redirect.

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

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

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

Error.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

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

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

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

Inherited from​

Error.prepareStackTrace