Interface: FlowSubBranchBuilder<TFlowIn, TBranchOut, THandle, TReceipt, TCustomMetrics, TStepOutputs>

Defined in: builders/flow-sub-branch-builder.ts:24

Fluent sub-builder passed to FlowBranchBuilder.when(...) and FlowBranchBuilder.otherwise(...).

Appends sequential steps inside a conditional branch case and threads accumulated step output types across .step(...) calls.

Type Parameters

Type Parameter	Default type	Description
TFlowIn	unknown	Enclosing flow input payload type.
TBranchOut	unknown	Unified branch output 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.

Methods

step()

step<TStepId, TStep>(
   id, 
   step, 
   configure?
): FlowSubBranchBuilder<TFlowIn, TBranchOut, THandle, TReceipt, TCustomMetrics, TStepOutputs & { readonly [K in string]: ExtractStepOutput<TStep> }>;

Defined in: builders/flow-sub-branch-builder.ts:51

Appends a sequential step inside this branch case.

Records the step's output type under TStepOutputs[TStepId] for subsequent steps in the same sub-branch.

Type Parameters

Type Parameter	Description
TStepId extends string	Literal step identifier string.
TStep extends StepASTNode	Step AST node type.

Parameters

Parameter	Type	Description
id	TStepId	Unique step identifier.
step	MaybeBuilder<TStep>	Step AST node or builder.
configure?	($s) => FlowStepConfigBuilder<TFlowIn, ExtractStepInput<TStep>, THandle, TReceipt, TCustomMetrics, TStepOutputs, TStepId>	Optional step input and interrupt configurator.

Returns

FlowSubBranchBuilder<TFlowIn, TBranchOut, THandle, TReceipt, TCustomMetrics, TStepOutputs & { readonly [K in string]: ExtractStepOutput<TStep> }>

New immutable sub-branch builder.

Properties

Property	Modifier	Type	Description	Defined in
steps	readonly	readonly ( | FlowStepNode<unknown, unknown, THandle, string> | FlowBranchNode<unknown, unknown, THandle, string>)[]	Ordered sequence of steps or nested branches inside this sub-branch.	builders/flow-sub-branch-builder.ts:33