Skip to main content

Interface: ExternalRunHandle

A handle to another run of the workspace (11 §2.24).

Properties​

runId​

readonly runId: string

The run id of a run-id target; empty for a workflow-id target.


workflowId?​

readonly optional workflowId?: string


workflowKey?​

readonly optional workflowKey?: string

The workflow key and id of a workflow-id target.

Methods​

cancel()​

cancel(): Promise<void>

Resolves when the cancel request was delivered, not when the run ends.

Returns​

Promise<void>


signal()​

signal<P>(signal, payload?): Promise<void>

Type Parameters​

P​

P

Parameters​

signal​

string | SignalDefinition<P>

payload?​

P

Returns​

Promise<void>