Interface: BaseWorkflowHandle<T>

common.BaseWorkflowHandle

Base WorkflowHandle interface, extended in workflow and client libs.

Transforms a workflow interface T into a client interface.

Type parameters

Name	Type
T	extends Workflow

Hierarchy

• BaseWorkflowHandle

  ↳ ChildWorkflowHandle

  ↳ WorkflowHandle

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

Name	Type
Args	extends any[] = []
Name	extends string = string

Parameters

Name	Type	Description
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>

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

Type parameters

Name	Type
Args	extends any[] = []

Parameters

Name	Type
signalName	string
options	WorkflowSignalOptions<Args>

Returns

Promise<void>