Class WorkflowBuilder<TOutput>

Builder used to construct workflow DAG definitions.

Type Parameters

TOutput = unknown
Final aggregate output type

Index

Constructors

constructor

Methods

after aggregate build capabilityAfter capabilityNode defaults node version

Constructors

constructor

new WorkflowBuilder<TOutput = unknown>(id: string): WorkflowBuilder<TOutput>
Type Parameters
- TOutput = unknown
  Final aggregate output type
Parameters
- id: string
  Unique workflow ID
Returns WorkflowBuilder<TOutput>
- Defined in src/core/workflow/WorkflowBuilder.ts:83

Methods

after

after(
    dependencies: string | string[],
    id: string,
    fn: WorkflowNodeFn,
    options?: Omit<WorkflowNodeOptions, "dependsOn">,
): this
Adds a node with dependencies in a more readable way than manual dependsOn.
Parameters
- dependencies: string | string[]
  One dependency id or list of dependency ids
- id: string
  Unique node identifier
- fn: WorkflowNodeFn
  Node execution factory
- Optionaloptions: Omit<WorkflowNodeOptions, "dependsOn">
  Additional node options (excluding dependsOn)
Returns this
Builder instance for chaining

Throws
When node id is duplicated
- Defined in src/core/workflow/WorkflowBuilder.ts:122

aggregate

aggregate(
fn: (results: Record<string, unknown>, state: WorkflowState) => TOutput,
): this
Registers a final aggregate mapper for workflow output.
Parameters
- fn: (results: Record<string, unknown>, state: WorkflowState) => TOutput
  Aggregate function
Returns this
Builder instance for chaining
- Defined in src/core/workflow/WorkflowBuilder.ts:142

build

build(): Workflow<TOutput>
Builds an immutable workflow definition snapshot.

Returns Workflow<TOutput>
Workflow definition
- Defined in src/core/workflow/WorkflowBuilder.ts:244

capabilityAfter

capabilityAfter<C extends CapabilityKeyType, TInput, TOutput>(
    dependencies: string | string[],
    id: string,
    capability: C,
    requestOrFactory: WorkflowCapabilityRequestFactory<TInput>,
    options?: Omit<WorkflowCapabilityNodeOptions, "dependsOn">,
): this
Adds a capability-backed node with dependencies.
Type Parameters
- C extends CapabilityKeyType
  Capability key
- TInput
  Capability request input type
- TOutput
  Capability output type
Parameters
- dependencies: string | string[]
  One dependency id or list of dependency ids
- id: string
  Unique node identifier
- capability: C
  Capability key to execute
- requestOrFactory: WorkflowCapabilityRequestFactory<TInput>
  Static request or state-aware request factory
- Optionaloptions: Omit<WorkflowCapabilityNodeOptions, "dependsOn">
  Optional node + capability-job options
Returns this
Builder instance for chaining

Throws
When node id is duplicated
- Defined in src/core/workflow/WorkflowBuilder.ts:225

capabilityNode

capabilityNode<C extends CapabilityKeyType, TInput, TOutput>(
    id: string,
    capability: C,
    requestOrFactory: WorkflowCapabilityRequestFactory<TInput>,
    options?: WorkflowCapabilityNodeOptions,
): this
Adds a capability-backed node without writing the boilerplate client.createCapabilityJob(...) call.
Type Parameters
- C extends CapabilityKeyType
  Capability key
- TInput
  Capability request input type
- TOutput
  Capability output type
Parameters
- id: string
  Unique node identifier
- capability: C
  Capability key to execute
- requestOrFactory: WorkflowCapabilityRequestFactory<TInput>
  Static request or state-aware request factory
- Optionaloptions: WorkflowCapabilityNodeOptions
  Optional node + capability-job options
Returns this
Builder instance for chaining

Throws
When node id is duplicated
- Defined in src/core/workflow/WorkflowBuilder.ts:186

defaults

defaults(defaults: WorkflowDefaults): this
Sets workflow-level default policies used by runner and capability helpers. Calling this multiple times merges values (latest wins per field).
Parameters
- defaults: WorkflowDefaults
  Default policy values
Returns this
Builder instance for chaining
- Defined in src/core/workflow/WorkflowBuilder.ts:154

node

node(id: string, fn: WorkflowNodeFn, options?: WorkflowNodeOptions): this
Adds a workflow node.
Parameters
- id: string
  Unique node identifier
- fn: WorkflowNodeFn
  Node execution factory
- Optionaloptions: WorkflowNodeOptions
  Optional node execution options
Returns this
Builder instance for chaining

Throws
When node id is duplicated
- Defined in src/core/workflow/WorkflowBuilder.ts:94

version

version(value: string | number): this
Sets a workflow version identifier used by resume drift checks.
Parameters
- value: string | number
  Version value
Returns this
Builder instance for chaining
- Defined in src/core/workflow/WorkflowBuilder.ts:168

Class WorkflowBuilder<TOutput>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WorkflowBuilder<TOutput>

Methods

after

Parameters

Returns this

Throws

aggregate

Parameters

Returns this

build

Returns Workflow<TOutput>

capabilityAfter

Type Parameters

Parameters

Returns this

Throws

capabilityNode

Type Parameters

Parameters

Returns this

Throws

defaults

Parameters

Returns this

node

Parameters

Returns this

Throws

version

Parameters

Returns this

Settings

On This Page