Skip to main content

Interface: WorkflowUpdateHandle<Ret>

Defined in: node_modules/@temporalio/client/lib/workflow-client.d.ts:262

A client-side handle to an Update.

Type Parameters​

Ret​

Ret

Properties​

updateId​

updateId: string

Defined in: node_modules/@temporalio/client/lib/workflow-client.d.ts:266

The ID of this Update request.

workflowId​

workflowId: string

Defined in: node_modules/@temporalio/client/lib/workflow-client.d.ts:270

The ID of the Workflow being targeted by this Update request.

workflowRunId?​

optional workflowRunId?: string

Defined in: node_modules/@temporalio/client/lib/workflow-client.d.ts:274

The ID of the Run of the Workflow being targeted by this Update request.

Methods​

result()​

result(): Promise<Ret>

Defined in: node_modules/@temporalio/client/lib/workflow-client.d.ts:279

Return the result of the Update.

Returns​

Promise<Ret>

Throws​

WorkflowUpdateFailedError if ApplicationFailure is thrown in the Update handler.