Interface: LaneSignalHandlerBuilder<TIn, TStepIds, TPayload>
Defined in: builders/lane-signal-handler-builder.ts:15
Fluent sub-builder for live signal steering and step rewind (lane.onSignal(sig, $ => ...)).
Configures the synchronous work-item input reducer (.update(mapper)) and the type-checked target step or branch ID in the bound flow (.rewindTo(stepId, options)).
Type Parameters
Methods
rewindTo()
rewindTo(stepId, options?): LaneSignalHandlerBuilder<TIn, TStepIds, TPayload>;Defined in: builders/lane-signal-handler-builder.ts:43
Constrains and sets the target step or branch ID in flow.nodes to rewind execution to.
Optionally binds a ScopeRewindHookASTNode executed when rewinding a Tier-1 'scope'.
Parameters
| Parameter | Type | Description |
|---|---|---|
stepId | TStepIds | Literal step or branch ID in the bound FlowNode. |
options? | { onRewind?: MaybeBuilder<ScopeRewindHookASTNode<unknown>>; } | Optional scope rewind hook. |
options.onRewind? | MaybeBuilder<ScopeRewindHookASTNode<unknown>> | - |
Returns
LaneSignalHandlerBuilder<TIn, TStepIds, TPayload>
New immutable signal handler builder.
toAST()
toAST(): LaneSignalHandlerConfig<TIn, TStepIds, TPayload>;Defined in: builders/lane-signal-handler-builder.ts:55
Compiles the signal handler configuration into a frozen LaneSignalHandlerConfig.
Throws at builder compilation time if either .update(mapper) or .rewindTo(stepId) is missing.
Returns
LaneSignalHandlerConfig<TIn, TStepIds, TPayload>
Deeply frozen lane signal handler configuration.
update()
update(mapper): LaneSignalHandlerBuilder<TIn, TStepIds, TPayload>;Defined in: builders/lane-signal-handler-builder.ts:29
Binds the synchronous reducer updating the active run's input from (currentInput, signalPayload).
Required before .toAST() can compile a valid LaneSignalHandlerConfig.
Parameters
| Parameter | Type | Description |
|---|---|---|
mapper | (current, payload) => TIn | Input update reducer. |
Returns
LaneSignalHandlerBuilder<TIn, TStepIds, TPayload>
New immutable signal handler builder.