Skip to main content

Interface: WorkflowUpdateHandle<Ret>

A client-side handle to an Update.

Type Parameters​

Ret​

Ret

Properties​

updateId​

updateId: string

The ID of this Update request.

workflowId​

workflowId: string

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

workflowRunId?​

optional workflowRunId?: string

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

Methods​

result()​

result(): Promise<Ret>

Return the result of the Update.

Returns​

Promise<Ret>

Throws​

WorkflowUpdateFailedError if ApplicationFailure is thrown in the Update handler.