Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/store-conformance / RestorableEffectLaneStore

Interface: RestorableEffectLaneStore

Defined in: packages/store-conformance/src/effect-lane.ts:26

The store shape under test: the capability plus the restore verb.

Extends

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
effectLanereadonlytrue-EffectLaneStore.effectLanepackages/core/dist/index.d.ts
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.EffectLaneStore.fencedWritespackages/core/dist/index.d.ts
leaseTtlMs?readonlynumberOptional TTL introspection (v1.35.0 review P2-4): the configured lease ttl in milliseconds. A store exposing it lets createWorker VERIFY at construction that the worker's renew cadence matches the store's expiry instead of trusting two config sources to agree; stores without it are accepted with the worker's own ttl.EffectLaneStore.leaseTtlMspackages/core/dist/index.d.ts

Methods

acquire()

ts
acquire(runId, owner): Promise<Lease>;

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

Parameters

ParameterType
runIdstring
ownerstring

Returns

Promise&lt;Lease&gt;

Inherited from

EffectLaneStore.acquire


append()

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

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

Parameters

ParameterType
runIdstring
eJournalEntry
lease?Lease

Returns

Promise&lt;void&gt;

Inherited from

EffectLaneStore.append


bumpRestorationGeneration()

ts
bumpRestorationGeneration(): Promise<number>;

Defined in: packages/store-conformance/src/effect-lane.ts:27

Returns

Promise&lt;number&gt;


delete()

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

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

Parameters

ParameterType
runIdstring
lease?Lease

Returns

Promise&lt;void&gt;

Inherited from

EffectLaneStore.delete


listRuns()

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

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

Parameters

ParameterType
f?RunFilter

Returns

Promise&lt;RunMeta[]&gt;

Inherited from

EffectLaneStore.listRuns


load()

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

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

Parameters

ParameterType
runIdstring

Returns

Promise&lt;JournalEntry[]&gt;

Inherited from

EffectLaneStore.load


putMeta()

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

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

Parameters

ParameterType
mRunMeta
lease?Lease

Returns

Promise&lt;void&gt;

Inherited from

EffectLaneStore.putMeta


release()

ts
release(l): Promise<void>;

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

Parameters

ParameterType
lLease

Returns

Promise&lt;void&gt;

Inherited from

EffectLaneStore.release


renew()

ts
renew(l): Promise<void>;

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

Parameters

ParameterType
lLease

Returns

Promise&lt;void&gt;

Inherited from

EffectLaneStore.renew


restorationGeneration()

ts
restorationGeneration(): Promise<number>;

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

The current restoration generation; 0 until a restore ever ran.

Returns

Promise&lt;number&gt;

Inherited from

EffectLaneStore.restorationGeneration