rulvar API reference / @rulvar/rulvar / LineageIndex
Class: LineageIndex
Defined in: packages/core/dist/index.d.ts
The incremental lineage fold: attempts, escalation debits, stall streaks, single-live-attempt, and legacy canonization, computed from journal entries only. absorb is idempotent by seq cursor; every read accepts an optional uptoSeq pin so renders stay snapshot-stable.
Constructors
Constructor
new LineageIndex(): LineageIndex;Returns
LineageIndex
Methods
absorb()
absorb(entries): void;Defined in: packages/core/dist/index.d.ts
Absorbs new entries (seq beyond the cursor); earlier ones are no-ops.
Parameters
| Parameter | Type |
|---|---|
entries | readonly JournalEntry[] |
Returns
void
attemptsUsed()
attemptsUsed(logicalTaskId, uptoSeq?): number;Defined in: packages/core/dist/index.d.ts
Parameters
| Parameter | Type |
|---|---|
logicalTaskId | string |
uptoSeq? | number |
Returns
number
escalationsUsed()
escalationsUsed(logicalTaskId, uptoSeq?): number;Defined in: packages/core/dist/index.d.ts
Parameters
| Parameter | Type |
|---|---|
logicalTaskId | string |
uptoSeq? | number |
Returns
number
hasLiveAttempt()
hasLiveAttempt(logicalTaskId): boolean;Defined in: packages/core/dist/index.d.ts
True while the LTID has an unsettled attempt (admitted, dispatched, or redispatched without a terminal), including admits whose decision entries have not landed yet. Backs the single-live-attempt invariant: a competing admit gets lineage_busy.
Parameters
| Parameter | Type |
|---|---|
logicalTaskId | string |
Returns
boolean
knownLogicalTaskIds()
knownLogicalTaskIds(): string[];Defined in: packages/core/dist/index.d.ts
Every LTID the fold has seen (diagnostics and renders).
Returns
string[]
noteAdmitted()
noteAdmitted(logicalTaskId): void;Defined in: packages/core/dist/index.d.ts
Registers a live admit strictly before its decision entry lands.
Parameters
| Parameter | Type |
|---|---|
logicalTaskId | string |
Returns
void
stallStreak()
stallStreak(logicalTaskId, uptoSeq?): number;Defined in: packages/core/dist/index.d.ts
The stall streak (pinnable to a snapshot seq).
Parameters
| Parameter | Type |
|---|---|
logicalTaskId | string |
uptoSeq? | number |
Returns
number
statsOf()
statsOf(logicalTaskId, uptoSeq?): LineageStats;Defined in: packages/core/dist/index.d.ts
The pinned LineageStats render.
Parameters
| Parameter | Type |
|---|---|
logicalTaskId | string |
uptoSeq? | number |