Skip to content

Interface: LaneTrackerConfigBuilder<TIn, TExternal, TExternalState> ​

Defined in: builders/lane-tracker-config-builder.ts:13

Fluent sub-builder for external issue tracker polling and state synchronization (lane.tracker(adapter, $ => ...)).

Configures polling cadence, external issue-to-work-item projection, and bidirectional lifecycle state mappings (onQueued, onRunning, onWaiting, onErrored, onCancelled, onExit).

Type Parameters ​

Type ParameterDefault typeDescription
TInunknownValidated lane work item input type.
TExternalunknownRaw external issue payload type from the tracker adapter.
TExternalState extends stringstringExternal tracker state string type.

Methods ​

everySeconds() ​

ts
everySeconds(seconds): LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>;

Defined in: builders/lane-tracker-config-builder.ts:27

Sets the polling interval in seconds for querying the external issue tracker.

Defaults to 60 seconds when .everySeconds(...) is not explicitly called.

Parameters ​

ParameterTypeDescription
secondsnumberPositive polling interval in seconds.

Returns ​

LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>

New immutable tracker builder.


from() ​

ts
from(mapper): LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>;

Defined in: builders/lane-tracker-config-builder.ts:38

Binds the synchronous mapper projecting an external issue into TIn (or undefined to skip).

Required before .toAST() can compile a valid LaneTrackerConfig.

Parameters ​

ParameterTypeDescription
mapper(external) => TIn | undefinedExternal issue projector callback.

Returns ​

LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>

New immutable tracker builder.


onCancelled() ​

ts
onCancelled(externalState): LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>;

Defined in: builders/lane-tracker-config-builder.ts:95

Maps the internal 'cancelled' lane state to externalState.

Synchronizes the external tracker issue state when a run is explicitly cancelled.

Parameters ​

ParameterTypeDescription
externalStateTExternalStateTarget external tracker state.

Returns ​

LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>

New immutable tracker builder.


onErrored() ​

ts
onErrored(externalState): LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>;

Defined in: builders/lane-tracker-config-builder.ts:84

Maps the internal 'errored' lane state to externalState.

Synchronizes the external tracker issue state when a run fails after exhausting retries.

Parameters ​

ParameterTypeDescription
externalStateTExternalStateTarget external tracker state.

Returns ​

LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>

New immutable tracker builder.


onExit() ​

ts
onExit(exitState, externalState): LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>;

Defined in: builders/lane-tracker-config-builder.ts:107

Maps a terminal flow exit state ('exit:${exitState}') to externalState.

Synchronizes the external tracker issue state when the bound flow exits with exitState.

Parameters ​

ParameterTypeDescription
exitStatestringInternal terminal exit state label (e.g. 'done').
externalStateTExternalStateTarget external tracker state.

Returns ​

LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>

New immutable tracker builder.


onQueued() ​

ts
onQueued(externalState): LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>;

Defined in: builders/lane-tracker-config-builder.ts:51

Maps the internal 'queued' lane state to externalState.

Synchronizes the external tracker issue state whenever a work item is queued.

Parameters ​

ParameterTypeDescription
externalStateTExternalStateTarget external tracker state.

Returns ​

LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>

New immutable tracker builder.


onRunning() ​

ts
onRunning(externalState): LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>;

Defined in: builders/lane-tracker-config-builder.ts:62

Maps the internal 'running' lane state to externalState.

Synchronizes the external tracker issue state whenever a work item acquires a concurrency slot.

Parameters ​

ParameterTypeDescription
externalStateTExternalStateTarget external tracker state.

Returns ​

LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>

New immutable tracker builder.


onWaiting() ​

ts
onWaiting(externalState): LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>;

Defined in: builders/lane-tracker-config-builder.ts:73

Maps the internal 'waiting' lane state to externalState.

Synchronizes the external tracker issue state when a run suspends on a human decision or prerequisite.

Parameters ​

ParameterTypeDescription
externalStateTExternalStateTarget external tracker state.

Returns ​

LaneTrackerConfigBuilder<TIn, TExternal, TExternalState>

New immutable tracker builder.


toAST() ​

ts
toAST(): LaneTrackerConfig<TIn, TExternal>;

Defined in: builders/lane-tracker-config-builder.ts:119

Compiles the tracker configuration into a frozen LaneTrackerConfig<TIn, TExternal>.

Throws at builder compilation time if .from(mapper) has not been configured.

Returns ​

LaneTrackerConfig<TIn, TExternal>

Deeply frozen lane tracker configuration.

Released under the MIT License.