Skip to main content

Interface: WorkflowHandle<T>

nexus.WorkflowHandle

A handle to a running workflow that is returned by the startWorkflow helper. This handle should be returned by WorkflowRunOperationStartHandler implementations.

The type parameter T carries the workflow's result type for downstream type inference in WorkflowRunOperationHandler. It is encoded in the workflowResultType brand so that WorkflowHandle<string> and WorkflowHandle<number> are structurally distinct.

Nexus support in Temporal SDK is experimental.

Type parameters

Name
T

Properties

runId

Readonly runId: string


workflowId

Readonly workflowId: string