Skip to main content

Interface: BaseWorkflowHandle<T>

Base WorkflowHandle interface, extended in workflow and client libs.

Transforms a workflow interface T into a client interface.

Extended by​

Type Parameters​

T​

T extends Workflow

Properties​

workflowId​

readonly workflowId: string

The workflowId of the current Workflow

Methods​

result()​

result(): Promise<WorkflowResultType<T>>

Promise that resolves when Workflow execution completes

Returns​

Promise<WorkflowResultType<T>>

signal()​

signal<Args, Name>(def, ...args): Promise<void>

Signal a running Workflow.

To provide call-site TypeInfo when signaling by name, use signalWithOptions.

Type Parameters​

Args​

Args extends any[] = []

Name​

Name extends string = string

Parameters​

def​

string | SignalDefinition<Args, Name>

a signal definition as returned from defineSignal, or a signal name

args​

...Args

Returns​

Promise<void>

Example​

await handle.signal(incrementSignal, 3);

signalWithOptions()​

signalWithOptions<Args>(signalName, options): Promise<void>

Experimental

Signal a running Workflow by Signal name with additional options, including call-site TypeInfo.

Type Parameters​

Args​

Args extends any[] = []

Parameters​

signalName​

string

options​

WorkflowSignalOptions<Args>

Returns​

Promise<void>