Skip to main content

Interface: StartWorkflowOptions

Defined in: src/interfaces.ts:744

Options for starting Temporal workflows. Extends base workflow start options with custom properties.

Example​

const options: StartWorkflowOptions = {
  taskQueue: 'orders',
  workflowId: `order-${orderId}`,
  signal: {
    name: 'start',
    args: [initialData]
  }
};

Indexable​

[key: string]: unknown

Properties​

signal?​

optional signal?: WorkflowSignalConfig

Defined in: src/interfaces.ts:748

Optional signal to send atomically with workflow start.

taskQueue​

taskQueue: string

Defined in: src/interfaces.ts:745

workflowId?​

optional workflowId?: string

Defined in: src/interfaces.ts:746