Class UmbCancelError

Hierarchy (View Summary, Expand)

UmbError
- UmbCancelError

Index

Properties

cause? message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace fromLegacyCancelError isUmbCancelError isUmbError

Constructors

constructor

new UmbCancelError(message?: string): UmbCancelError
Parameters
- Optionalmessage: string
Returns UmbCancelError
Inherited from UmbError.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1082
new UmbCancelError(message?: string, options?: ErrorOptions): UmbCancelError
Parameters
- Optionalmessage: string
- Optionaloptions: ErrorOptions
Returns UmbCancelError
Inherited from UmbError.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1082

Properties

`Optional`cause

cause?: unknown

message

message: string

name

name: string = 'UmbCancelError'

`Optional`stack

stack?: string

`Static` `Optional`prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

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

`Static`stackTraceLimit

stackTraceLimit: number

Methods

`Static`captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from UmbError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:136

`Static`fromLegacyCancelError

fromLegacyCancelError(error: Error): UmbCancelError
Transforms a CancelError into an UmbCancelError.
Parameters
- error: Error
  The CancelError to transform.
Returns UmbCancelError
The transformed UmbCancelError.

Deprecated
Use UmbCancelError.isUmbCancelError instead and map your object to UmbCancelError if needed.
- Defined in src/packages/core/resources/umb-error.ts:24

`Static`isUmbCancelError

isUmbCancelError(error: unknown): error is UmbCancelError
Parameters
- error: unknown
Returns error is UmbCancelError
- Defined in src/packages/core/resources/umb-error.ts:14

`Static`isUmbError

isUmbError(error: unknown): error is UmbError
Parameters
- error: unknown
Returns error is UmbError
Inherited from UmbError.isUmbError
- Defined in src/packages/core/resources/umb-error.ts:6