Rulvar API reference

---

Rulvar API reference / @rulvar/rulvar / JournalStore

Interface: JournalStore

Defined in: packages/core/dist/index.d.ts

Extended by

• LeasableStore
• MetaLookupStore

Properties

Property	Modifier	Type	Description	Defined in
fencedWrites?	readonly	true	Fenced 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/dist/index.d.ts

Methods

append()

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

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
runId	string
e	JournalEntry
lease?	Lease

Returns

Promise<void>

---

delete()

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

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
runId	string
lease?	Lease

Returns

Promise<void>

---

listRuns()

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

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
f?	RunFilter

Returns

Promise<RunMeta[]>

---

load()

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

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
runId	string

Returns

Promise<JournalEntry[]>

---

putMeta()

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

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
m	RunMeta
lease?	Lease

Returns

Promise<void>