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

  • Parameters

    • Optional message: string

    Returns CancelError

Properties

message: string
name: string
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

stack?: string
stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void