Skip to main content

Class: CancelledFailure

common.CancelledFailure

This error is thrown when Cancellation has been requested. To allow Cancellation to happen, let it propagate. To ignore Cancellation, catch it and continue executing. Note that Cancellation can only be requested a single time, so your Workflow/Activity Execution will not receive further Cancellation requests.

When a Workflow or Activity has been successfully cancelled, a CancelledFailure will be the cause.

Hierarchy

Constructors

constructor

new CancelledFailure(message, details?, cause?)

Parameters

NameType
messageundefined | string
details?unknown[]
cause?Error

Overrides

TemporalFailure.constructor

Properties

cause

Optional Readonly cause: Error

Inherited from

TemporalFailure.cause


details

Readonly details: unknown[]


failure

Optional failure: IFailure

The original failure that constructed this error.

Only present if this error was generated from an external operation.

Inherited from

TemporalFailure.failure


message

message: string

Inherited from

TemporalFailure.message


name

Readonly name: string

Overrides

TemporalFailure.name


stack

Optional stack: string

Inherited from

TemporalFailure.stack


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
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

TemporalFailure.prepareStackTrace


stackTraceLimit

Static stackTraceLimit: number

Inherited from

TemporalFailure.stackTraceLimit

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

TemporalFailure.captureStackTrace