Class: CancelError
@ima/core.CancelError
Extension of GenericError which is used in route handling ot cancel currently managed route before proceeding with execution with new one.
Hierarchy
GenericError<{status:409}>↳
CancelError
Constructors
constructor
• new CancelError(message?)
Parameters
| Name | Type | Default value |
|---|---|---|
message | string | 'Canceled' |
Overrides
Defined in
packages/core/src/error/CancelError.ts:8
Properties
_params
• Protected _params: { status: 409 } & GenericErrorParams
Inherited from
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:1068
name
• name: string
Inherited from
Defined in
node_modules/typescript/lib/lib.es5.d.ts:1067
stack
• Optional stack: string
Inherited from
Defined in
node_modules/typescript/lib/lib.es5.d.ts:1069
prepareStackTrace
▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any
Type declaration
▸ (err, stackTraces): any
Optional override for formatting stack traces
Parameters
| Name | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
GenericError.prepareStackTrace
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.
Returns
number
The HTTP status to send to the client.
See
http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
Inherited from
Defined in
packages/core/src/error/GenericError.ts:39
getParams
▸ getParams(): { status: 409 } & 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.
Returns
{ status: 409 } & GenericErrorParams
The route parameters of the route at which the error has occurred.
See
Error#getHttpStatus
Inherited from
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.
Inherited from
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.
Inherited from
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
GenericError.captureStackTrace
Defined in
node_modules/@types/node/globals.d.ts:4