Interface: WorkflowHandleWithFirstExecutionRunId<T>

client.WorkflowHandleWithFirstExecutionRunId

This interface is exactly the same as WorkflowHandle except it includes the firstExecutionRunId returned from WorkflowClient.start.

Type parameters

Name	Type
T	extends Workflow = Workflow

Hierarchy

• WorkflowHandle<T>

  ↳ WorkflowHandleWithFirstExecutionRunId

Properties

client

• Readonly client: WorkflowClient

Readonly accessor to the underlying WorkflowClient

Inherited from

WorkflowHandle.client

---

firstExecutionRunId

• Readonly firstExecutionRunId: string

Run Id of the first Execution in the Workflow Execution Chain.

---

workflowId

• Readonly workflowId: string

The workflowId of the current Workflow

Inherited from

WorkflowHandle.workflowId

Methods

cancel

▸ cancel(): Promise<IRequestCancelWorkflowExecutionResponse>

Cancel a running Workflow.

When a Workflow is cancelled, the root scope throws CancelledFailure with message: 'Workflow canceled'. That means that all cancellable scopes will throw CancelledFailure.

Cancellation may be propagated to Activities depending on ActivityOptions#cancellationType, after which Activity calls may throw an ActivityFailure, and isCancellation(error) will be true (see isCancellation).

Cancellation may be propagated to Child Workflows depending on ChildWorkflowOptions#cancellationType, after which calls to executeChild and ChildWorkflowHandle#result will throw, and isCancellation(error) will be true (see isCancellation).

Returns

Promise<IRequestCancelWorkflowExecutionResponse>

Inherited from

WorkflowHandle.cancel

---

describe

▸ describe(): Promise<WorkflowExecutionDescription>

Describe the current workflow execution

Returns

Promise<WorkflowExecutionDescription>

Inherited from

WorkflowHandle.describe

---

executeUpdate

▸ executeUpdate<Ret, Args, Name>(def, options): Promise<Ret>

Start an Update and wait for the result.

Update is an experimental feature.

Type parameters

Name	Type
Ret	Ret
Args	extends [any, ...any[]]
Name	extends string = string

Parameters

Name	Type	Description
def	string | UpdateDefinition<Ret, Args, Name>	an Update definition as returned from defineUpdate
options	WorkflowUpdateOptions & { args: Args }	Update arguments

Returns

Promise<Ret>

Throws

WorkflowUpdateFailedError if Update validation fails or if ApplicationFailure is thrown in the Update handler.

Example

const updateResult = await handle.executeUpdate(incrementAndGetValueUpdate, { args: [2] });

Inherited from

WorkflowHandle.executeUpdate

▸ executeUpdate<Ret, Args, Name>(def, options?): Promise<Ret>

Type parameters

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

Parameters

Name	Type
def	string | UpdateDefinition<Ret, Args, Name>
options?	WorkflowUpdateOptions & { args?: Args }

Returns

Promise<Ret>

Inherited from

WorkflowHandle.executeUpdate

---

fetchHistory

▸ fetchHistory(): Promise<IHistory>

Return a workflow execution's history

Returns

Promise<IHistory>

Inherited from

WorkflowHandle.fetchHistory

---

getUpdateHandle

▸ getUpdateHandle<Ret>(updateId): WorkflowUpdateHandle<Ret>

Get a handle to an Update of this Workflow.

Type parameters

Name
Ret

Parameters

Name	Type
updateId	string

Returns

WorkflowUpdateHandle<Ret>

Inherited from

WorkflowHandle.getUpdateHandle

---

query

▸ query<Ret, Args>(def, ...args): Promise<Ret>

Query a running or completed Workflow.

Type parameters

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

Parameters

Name	Type	Description
def	string | QueryDefinition<Ret, Args, string>	a query definition as returned from defineQuery or query name (string)
...args	Args	-

Returns

Promise<Ret>

Example

await handle.query(getValueQuery);
await handle.query<number, []>('getValue');

Inherited from

WorkflowHandle.query

---

result

▸ result(): Promise<WorkflowResultType<T>>

Promise that resolves when Workflow execution completes

Returns

Promise<WorkflowResultType<T>>

Inherited from

WorkflowHandle.result

---

signal

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

Signal a running Workflow.

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
...args	Args	-

Returns

Promise<void>

Example

await handle.signal(incrementSignal, 3);

Inherited from

WorkflowHandle.signal

---

startUpdate

▸ startUpdate<Ret, Args, Name>(def, options): Promise<WorkflowUpdateHandle<Ret>>

Start an Update and receive a handle to the Update. The Update validator (if present) is run before the handle is returned.

Update is an experimental feature.

Type parameters

Name	Type
Ret	Ret
Args	extends [any, ...any[]]
Name	extends string = string

Parameters

Name	Type	Description
def	string | UpdateDefinition<Ret, Args, Name>	an Update definition as returned from defineUpdate
options	WorkflowUpdateOptions & { args: Args }	Update arguments

Returns

Promise<WorkflowUpdateHandle<Ret>>

Throws

WorkflowUpdateFailedError if Update validation fails.

Example

const updateHandle = await handle.startUpdate(incrementAndGetValueUpdate, { args: [2] });
const updateResult = await updateHandle.result();

Inherited from

WorkflowHandle.startUpdate

▸ startUpdate<Ret, Args, Name>(def, options?): Promise<WorkflowUpdateHandle<Ret>>

Type parameters

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

Parameters

Name	Type
def	string | UpdateDefinition<Ret, Args, Name>
options?	WorkflowUpdateOptions & { args?: Args }

Returns

Promise<WorkflowUpdateHandle<Ret>>

Inherited from

WorkflowHandle.startUpdate

---

terminate

▸ terminate(reason?): Promise<ITerminateWorkflowExecutionResponse>

Terminate a running Workflow

Parameters

Name	Type
reason?	string

Returns

Promise<ITerminateWorkflowExecutionResponse>

Inherited from

WorkflowHandle.terminate