Skip to main content

Interface: TemporalOperationHandlerOptions

Experimental

Options for customizing a TemporalOperationHandler.

Temporal Operation handlers are experimental.

Properties​

cancelActivity?​

optional cancelActivity?: (ctx, options) => Promise<void>

Experimental

Parameters​

ctx​

TemporalCancelOperationContext

options​

CancelActivityOptions

Returns​

Promise<void>

cancelWorkflowRun?​

optional cancelWorkflowRun?: (ctx, options) => Promise<void>

Experimental

Handler invoked to cancel a workflow-run-backed operation. Defaults to canceling the workflow.

Parameters​

ctx​

TemporalCancelOperationContext

options​

CancelWorkflowRunOptions

Returns​

Promise<void>

cancelWorkflowUpdate?​

optional cancelWorkflowUpdate?: (ctx, options) => Promise<void>

Experimental

Handler invoked to cancel an UpdateWorkflow-backed operation.

There is no meaningful default behavior for canceling a Workflow Update, so if this is not provided, canceling such an operation fails with a NOT_IMPLEMENTED Nexus handler error.

Parameters​

ctx​

TemporalCancelOperationContext

options​

CancelWorkflowUpdateOptions

Returns​

Promise<void>