Skip to main content

Interface: GetWorkflowHandleOptions<R>

Options for WorkflowClient.getHandle

Extends​

Type Parameters​

R​

R = any

Properties​

firstExecutionRunId?​

optional firstExecutionRunId?: string

ID of the first execution in the Workflow execution chain.

When getting a handle with no runId, pass this option to ensure some WorkflowHandle methods (e.g. terminate and cancel) don't affect executions from another chain.

followRuns?​

optional followRuns?: boolean

If set to true, instructs the client to follow the chain of execution before returning a Workflow's result.

Workflow execution is chained if the Workflow has a cron schedule or continues-as-new or configured to retry after failure or timeout.

Default​

true

Inherited from​

WorkflowResultOptions.followRuns

typeInfo?​

optional typeInfo?: Replace<PayloadTypeInfo, OutputTypeInfo<R>>

Experimental

Type information used to decode the Workflow result.

This is only needed when getting a result from an existing Workflow handle or when the Workflow definition is not available to this client.

Inherited from​

WorkflowResultOptions.typeInfo

workflow?​

optional workflow?: undefined

Workflow definitions are accepted through WorkflowHandleDefinitionOptions.