rulvar API reference

---

rulvar API reference / @rulvar/rulvar / LeasableStore

Interface: LeasableStore

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

Lease capability: acquire on a held lease MUST reject with a typed LeaseHeldError; renew MUST run at an interval of at most ttl/3; an append carrying a stale epoch MUST be rejected and never appear in load.

Extends

• JournalStore

Methods

acquire()

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

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

Parameters

Parameter	Type
runId	string
owner	string

Returns

Promise<Lease>

---

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>

Inherited from

JournalStore.append

---

delete()

delete(runId): Promise<void>;

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

Parameters

Parameter	Type
runId	string

Returns

Promise<void>

Inherited from

JournalStore.delete

---

listRuns()

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

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

Parameters

Parameter	Type
f?	RunFilter

Returns

Promise<RunMeta[]>

Inherited from

JournalStore.listRuns

---

load()

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

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

Parameters

Parameter	Type
runId	string

Returns

Promise<JournalEntry[]>

Inherited from

JournalStore.load

---

putMeta()

putMeta(m): Promise<void>;

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

Parameters

Parameter	Type
m	RunMeta

Returns

Promise<void>

Inherited from

JournalStore.putMeta

---

release()

release(l): Promise<void>;

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

Parameters

Parameter	Type
l	Lease

Returns

Promise<void>

---

renew()

renew(l): Promise<void>;

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

Parameters

Parameter	Type
l	Lease

Returns

Promise<void>