Skip to main content

Interface: TemporalOperationHandlerOptions

nexus.TemporalOperationHandlerOptions

Options for customizing a TemporalOperationHandler.

Temporal Operation handlers are experimental.

Properties​

cancelActivity​

• Optional cancelActivity: (ctx: TemporalCancelOperationContext, options: CancelActivityOptions) => Promise<void>

Type declaration​

▸ (ctx, options): Promise<void>

Parameters​
NameType
ctxTemporalCancelOperationContext
optionsCancelActivityOptions
Returns​

Promise<void>


cancelWorkflowRun​

• Optional cancelWorkflowRun: (ctx: TemporalCancelOperationContext, options: CancelWorkflowRunOptions) => Promise<void>

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

Type declaration​

▸ (ctx, options): Promise<void>

Parameters​
NameType
ctxTemporalCancelOperationContext
optionsCancelWorkflowRunOptions
Returns​

Promise<void>


cancelWorkflowUpdate​

• Optional cancelWorkflowUpdate: (ctx: TemporalCancelOperationContext, options: CancelWorkflowUpdateOptions) => Promise<void>

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.

Type declaration​

▸ (ctx, options): Promise<void>

Parameters​
NameType
ctxTemporalCancelOperationContext
optionsCancelWorkflowUpdateOptions
Returns​

Promise<void>