Class: GenericError<T>
@ima/core.GenericError
Implementation of the Error interface, providing more advanced error API.
Type parameters
| Name | Type |
|---|---|
T | unknown |
Hierarchy
↳
GenericError↳↳
CancelError↳↳
CancelError
Constructors
constructor
• new GenericError<T>(message, params?)
Initializes the generic IMA error.
Type parameters
| Name | Type |
|---|---|
T | unknown |
Parameters
| Name | Type | Description |
|---|---|---|
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. |
Overrides
Defined in
packages/core/src/error/GenericError.ts:27
Properties
_params
• Protected _params: T & GenericErrorParams
Defined in
packages/core/src/error/GenericError.ts:16
cause
• Optional cause: unknown
Inherited from
Defined in
node_modules/typescript/lib/lib.es2022.error.d.ts:24
message
• message: string
Inherited from
Defined in
node_modules/typescript/lib/lib.es5.d.ts:1055
name
• name: string
Inherited from
Defined in
node_modules/typescript/lib/lib.es5.d.ts:1054
stack
• Optional stack: string
Inherited from
Defined in
node_modules/typescript/lib/lib.es5.d.ts:1056
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
Defined in
node_modules/@types/node/globals.d.ts:11
stackTraceLimit
▪ Static stackTraceLimit: number
Inherited from
Defined in
node_modules/@types/node/globals.d.ts:13
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
Defined in
packages/core/src/error/GenericError.ts:39
getParams
▸ getParams(): T & GenericErrorParams
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
The route parameters of the route at which the error has occurred.
Overrides
Defined in
packages/core/src/error/GenericError.ts:46
isClientError
▸ isClientError(): boolean
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
Defined in
packages/core/src/error/GenericError.ts:53
isRedirection
▸ isRedirection(): boolean
Tests, whether the specified error should lead to a redirect.
Returns
boolean
true if the error should cause a redirect.
Overrides
Defined in
packages/core/src/error/GenericError.ts:60
captureStackTrace
▸ Static captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
| Name | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
Defined in
node_modules/@types/node/globals.d.ts:4