Skip to main content

Class: WithStartWorkflowOperation<T>

client.WithStartWorkflowOperation

Define how to start a workflow when using WorkflowClient.startUpdateWithStart and WorkflowClient.executeUpdateWithStart. workflowIdConflictPolicy is required in the options.

Update-with-Start is an experimental feature and may be subject to change.

Type parameters

NameType
Textends Workflow

Constructors

constructor

new WithStartWorkflowOperation<T>(workflowTypeOrFunc, options): WithStartWorkflowOperation<T>

Type parameters

NameType
Textends Workflow

Parameters

NameType
workflowTypeOrFuncstring | T
optionsWorkflowOptions & Parameters<T> extends [any, ...any[]] ? { args: [any, ...any[]] & Parameters<T> | Readonly<[any, ...any[]] & Parameters<T>> } : { args?: Parameters<T> | Readonly<Parameters<T>> } & { workflowIdConflictPolicy: WorkflowIdConflictPolicy }

Returns

WithStartWorkflowOperation<T>

Properties

options

options: WorkflowOptions & Parameters<T> extends [any, ...any[]] ? { args: [any, ...any[]] & Parameters<T> | Readonly<[any, ...any[]] & Parameters<T>> } : { args?: Parameters<T> | Readonly<Parameters<T>> } & { workflowIdConflictPolicy: WorkflowIdConflictPolicy }


workflowTypeOrFunc

workflowTypeOrFunc: string | T

Methods

workflowHandle

workflowHandle(): Promise<WorkflowHandle<T>>

Returns

Promise<WorkflowHandle<T>>