Interface: FlowStepConfigBuilder<TFlowIn, TStepIn, THandle, TReceipt, TCustomMetrics, TStepOutputs, TStepId>

Defined in: builders/flow-step-config-builder.ts:22

Fluent step configurator passed to flow.step(id, step, $s => ...) and subBranch.step(id, step, $s => ...).

Configures step input projection from (flowInput, priorSteps, scopeReceipt) and attaches step-level .onInterrupt() edge handlers.

Extends

• AstBuilder<FlowStepNode<TStepIn, unknown, THandle, TStepId>>

Type Parameters

Type Parameter	Default type	Description
TFlowIn	unknown	Enclosing flow input payload type.
TStepIn	unknown	Target step input payload type.
THandle	unknown	Isolation scope handle type.
TReceipt	unknown	Inspected scope receipt type.
TCustomMetrics extends Record<string, unknown>	Record<string, unknown>	Custom step telemetry metrics type.
TStepOutputs extends Record<string, unknown>	Record<string, never>	Accumulated step outputs map type.
TStepId extends string	string	Literal step identifier string.

Methods

inputFrom()

inputFrom(mapper): FlowStepConfigBuilder<TFlowIn, TStepIn, THandle, TReceipt, TCustomMetrics, TStepOutputs, TStepId>;

Defined in: builders/flow-step-config-builder.ts:40

Projects (flowInput, priorSteps, scopeReceipt) into the step's input payload TStepIn.

Invoked immediately before the step executes, after refreshing scopeReceipt = await scope.inspect(handle).

Parameters

Parameter	Type	Description
mapper	(flowInput, priorSteps, scopeReceipt) => TStepIn	Synchronous step input mapper.

Returns

FlowStepConfigBuilder<TFlowIn, TStepIn, THandle, TReceipt, TCustomMetrics, TStepOutputs, TStepId>

New immutable step config builder.

---

onInterrupt()

onInterrupt<TPayload>(interrupt, configure): FlowStepConfigBuilder<TFlowIn, TStepIn, THandle, TReceipt, TCustomMetrics, TStepOutputs, TStepId>;

Defined in: builders/flow-step-config-builder.ts:56

Binds a step-level interrupt handler overriding or supplementing actor-level handlers.

Step-level handlers take precedence over actor-level .onInterrupt() handlers for the same InterruptNode.

Type Parameters

Type Parameter	Description
TPayload	Interrupt payload type.

Parameters

Parameter	Type	Description
interrupt	MaybeBuilder<InterruptNode<TPayload>>	Target interrupt node or builder.
configure	($intr) => AstBuilder<InterruptHandlerNode<TFlowIn, TPayload, THandle>>	Interrupt edge configurator.

Returns

FlowStepConfigBuilder<TFlowIn, TStepIn, THandle, TReceipt, TCustomMetrics, TStepOutputs, TStepId>

New immutable step config builder.

---

toAST()

toAST(): FlowStepNode;

Defined in: ast/ast-builder.ts:20

Compiles the current builder configuration into a deeply frozen passive AST node.

Validates required builder invariants at compilation time and returns an immutable plain-object AST representation containing zero execution methods.

Returns

FlowStepNode

Deeply frozen passive AST node.

Inherited from

AstBuilder.toAST