Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/core / JournalStore

Interface: JournalStore

Defined in: packages/core/src/l0/spi/store.ts:205

Extended by

Properties

PropertyModifierTypeDescriptionDefined in
fencedWrites?readonlytrueFenced writes capability (the fenced run state RFC, phase 2), optional exactly like getMeta and leaseTtlMs: a store declaring fencedWrites: true PROMISES that every mutation carrying a lease (append, putMeta, delete) verifies it is the CURRENT holder for the run the mutation targets, atomically with the mutation itself, and rejects with the typed LeaseHeldError leaving nothing mutated when it is not (stale epoch, foreign owner, expired, or a lease whose runId is not the mutation's run). The engine threads the segment's lease into every one of these writes on a leased resume, so over a declaring store a superseded worker cannot overwrite run meta or delete run state, exactly as it already cannot append. A mutation carrying NO lease keeps the single-writer semantics unchanged. Stores written before this capability are unaffected: without the marker the extra argument is ignored and hosts know the surface is advisory.packages/core/src/l0/spi/store.ts:228

Methods

append()

ts
append(
   runId, 
   e, 
lease?): Promise<void>;

Defined in: packages/core/src/l0/spi/store.ts:206

Parameters

ParameterType
runIdstring
eJournalEntry
lease?Lease

Returns

Promise&lt;void&gt;


delete()

ts
delete(runId, lease?): Promise<void>;

Defined in: packages/core/src/l0/spi/store.ts:210

Parameters

ParameterType
runIdstring
lease?Lease

Returns

Promise&lt;void&gt;


listRuns()

ts
listRuns(f?): Promise<RunMeta[]>;

Defined in: packages/core/src/l0/spi/store.ts:209

Parameters

ParameterType
f?RunFilter

Returns

Promise&lt;RunMeta[]&gt;


load()

ts
load(runId): Promise<JournalEntry[]>;

Defined in: packages/core/src/l0/spi/store.ts:207

Parameters

ParameterType
runIdstring

Returns

Promise&lt;JournalEntry[]&gt;


putMeta()

ts
putMeta(m, lease?): Promise<void>;

Defined in: packages/core/src/l0/spi/store.ts:208

Parameters

ParameterType
mRunMeta
lease?Lease

Returns

Promise&lt;void&gt;