Skip to main content

Interface: CancellationScopeOptions

workflow.CancellationScopeOptions

Option for constructing a CancellationScope

Properties​

cancellable​

• cancellable: boolean

If false, prevent outer cancellation from propagating to inner scopes, Activities, timers, and Triggers, defaults to true. (Scope still propagates CancelledFailure thrown from within).

parent​

• Optional parent: CancellationScope | typeof NO_PARENT

An optional CancellationScope (useful for running background tasks). The NO_PARENT symbol is reserved for the root scope.

timeout​

• Optional timeout: number

Time in milliseconds before the scope cancellation is automatically requested