MemoryKv

Class exported by @botmesh/core/spi.

Defined in: durability/kv.ts:101

In-process DurableKv: the reference implementation.

Implements

• DurableKv

Constructors

Constructor

new MemoryKv(): MemoryKv;

Returns

MemoryKv

Methods

get()

get(table, id): Promise<DurableKvEntry | undefined>;

Defined in: durability/kv.ts:110

Parameters

Parameter	Type
table	string
id	string

Returns

Promise<DurableKvEntry | undefined>

Implementation of

DurableKv.get

---

insert()

insert(
   table, 
   id, 
   value, 
   index
): Promise<string | undefined>;

Defined in: durability/kv.ts:115

Parameters

Parameter	Type
table	string
id	string
value	string
index	DurableKvIndex

Returns

Promise<string | undefined>

Implementation of

DurableKv.insert

---

replace()

replace(
   table, 
   id, 
   version, 
   value, 
   index
): Promise<string | undefined>;

Defined in: durability/kv.ts:123

Parameters

Parameter	Type
table	string
id	string
version	string
value	string
index	DurableKvIndex

Returns

Promise<string | undefined>

Implementation of

DurableKv.replace

---

remove()

remove(
   table, 
   id, 
   version
): Promise<boolean>;

Defined in: durability/kv.ts:133

Parameters

Parameter	Type
table	string
id	string
version	string

Returns

Promise<boolean>

Implementation of

DurableKv.remove

---

range()

range(
   table, 
   index, 
   max, 
   limit
): Promise<string[]>;

Defined in: durability/kv.ts:142

Parameters

Parameter	Type
table	string
index	keyof DurableKvIndex
max	number
limit	number

Returns

Promise<string[]>

Implementation of

DurableKv.range

---

snapshot()

snapshot(): MemoryKvSnapshot;

Defined in: durability/kv.ts:153

Copy of the whole state.

Returns

MemoryKvSnapshot

---

restore()

restore(snapshot): void;

Defined in: durability/kv.ts:162

Replace the whole state with snapshot.

Parameters

Parameter	Type
snapshot	MemoryKvSnapshot

Returns

void

Throws

on an invalid snapshot.