Interface: CreateWorkflowConfig<TInputSchema, TOutputSchema, TStateSchema>#

Defined in: packages/workflow-core/src/define/define-workflow.ts:43

Type Parameters#

TInputSchema#

TInputSchema extends SchemaInput | undefined

TOutputSchema#

TOutputSchema extends SchemaInput | undefined

TStateSchema#

TStateSchema extends SchemaInput | undefined

Properties#

defaultStepRetry?#

optional defaultStepRetry: StepRetryOptions;

optional defaultStepRetry: StepRetryOptions;

Defined in: packages/workflow-core/src/define/define-workflow.ts:65

Default retry policy applied to every ctx.step() call that doesn't carry its own { retry } option.

description?#

optional description: string;

optional description: string;

Defined in: packages/workflow-core/src/define/define-workflow.ts:49

id#

id: string;

id: string;

Defined in: packages/workflow-core/src/define/define-workflow.ts:48

initialize()?#

optional initialize: (args) => TStateSchema extends SchemaInput ? Partial<InferSchema<TStateSchema<TStateSchema>>> : Record<string, unknown>;

optional initialize: (args) => TStateSchema extends SchemaInput ? Partial<InferSchema<TStateSchema<TStateSchema>>> : Record<string, unknown>;

Defined in: packages/workflow-core/src/define/define-workflow.ts:56

Parameters#

args#

input#

TInputSchema extends SchemaInput ? InferSchema<TInputSchema<TInputSchema>> : unknown

Returns#

TStateSchema extends SchemaInput ? Partial<InferSchema<TStateSchema<TStateSchema>>> : Record<string, unknown>

input?#

optional input: TInputSchema;

optional input: TInputSchema;

Defined in: packages/workflow-core/src/define/define-workflow.ts:53

output?#

optional output: TOutputSchema;

optional output: TOutputSchema;

Defined in: packages/workflow-core/src/define/define-workflow.ts:54

state?#

optional state: TStateSchema;

optional state: TStateSchema;

Defined in: packages/workflow-core/src/define/define-workflow.ts:55

version?#

optional version: string;

optional version: string;

Defined in: packages/workflow-core/src/define/define-workflow.ts:52

Caller-supplied version identifier (e.g. 'v1', '2026-05-15'). Used with selectWorkflowVersion for cross-version routing.