KvDurability

Class exported by @botmesh/core/spi.

Defined in: durability/journal.ts:382

A DurabilityBackend over any DurableKv. Store packages build their backends this way (new KvDurability(new PostgresDurableKv(pool))).

Extended by

• MemoryDurability
• FileDurability

Implements

• DurabilityBackend

Constructors

Constructor

new KvDurability(kv, options?): KvDurability;

Defined in: durability/journal.ts:388

Parameters

Parameter	Type
kv	DurableKv
options?	KvDurabilityOptions

Returns

KvDurability

Properties

inbox

readonly inbox: InboxJournal;

Defined in: durability/journal.ts:383

Implementation of

DurabilityBackend.inbox

---

outbox

readonly outbox: OutboxJournal;

Defined in: durability/journal.ts:384

Implementation of

DurabilityBackend.outbox

---

exclusive

readonly exclusive: boolean;

Defined in: durability/journal.ts:385

true when only one process can use the backend at a time (memory, file). A restarted process then knows every lease of its instanceId is its own dead incarnation’s.

Implementation of

DurabilityBackend.exclusive

---

scopeName

readonly scopeName: string | undefined;

Defined in: durability/journal.ts:387

The scope of this view (undefined = the unscoped tables).

---

kv

readonly kv: DurableKv;

Defined in: durability/journal.ts:388

Methods

scope()

scope(name): KvDurability;

Defined in: durability/journal.ts:397

A view over the same KV holding only the records of name (tables inbox:<name> / outbox:<name>).

Parameters

Parameter	Type
name	string

Returns

KvDurability

Implementation of

DurabilityBackend.scope

---

start()

start(): Promise<void>;

Defined in: durability/journal.ts:402

Called by bot.start() before anything is replayed.

Returns

Promise<void>

Implementation of

DurabilityBackend.start

---

stop()

stop(): Promise<void>;

Defined in: durability/journal.ts:403

Called by bot.stop() after the provider stopped.

Returns

Promise<void>

Implementation of

DurabilityBackend.stop