Class CancelError

Error thrown when waiting for a result from a job that is canceled.

If you await, yield *, .then(), .catch(), getResult() or otherwise wait on the result of a job that is canceled, this is the type of error you'll get.

Hierarchy

  • Error
    • CancelError

Constructors

constructor

Properties

message name prepareStackTrace? stack? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • new CancelError(message?: string): CancelError

  • Parameters

    • Optional message: string

    Returns CancelError

Properties

message

message: string

name

name: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

    • (err: Error, stackTraces: CallSite[]): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Optional stack

stack?: string

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructormessagenameprepareStackTracestackstackTraceLimitcaptureStackTrace