Function: createFlowBranchBuilder()

function createFlowBranchBuilder<TFlowIn, TBranchOut, THandle, TBranchId, TReceipt, TCustomMetrics, TStepOutputs>(id): FlowBranchBuilder<TFlowIn, TBranchOut, THandle, TBranchId, TReceipt, TCustomMetrics, TStepOutputs>;

Defined in: builders/create-flow-branch-builder.ts:23

Creates a fluent FlowBranchBuilder for flow.branch(id, $b => ...).

Validates that id is a non-empty branch identifier and initializes an immutable FlowBranchBuilder with empty .when() cases and .otherwise() fallback steps.

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.
TBranchId extends string	string	Literal branch step identifier string.
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.

Parameters

Parameter	Type	Description
id	TBranchId	Unique identifier of the branch node.

Returns

FlowBranchBuilder<TFlowIn, TBranchOut, THandle, TBranchId, TReceipt, TCustomMetrics, TStepOutputs>

Frozen branch builder.