itd-api / KeyValueStore

Interface: KeyValueStore<T>

Defined in: core/key-value-store.ts:15

Минимальный backend именованных значений.

Контракт ничего не знает о сессиях, сериализации или конкретной базе данных. Значение undefined означает отсутствие ключа; хранить undefined как самостоятельное значение нельзя.

Extended by

• EnumerableKeyValueStore

Type Parameters

T

T

Methods

delete()

delete(key): KeyValueStoreResult<void>;

Defined in: core/key-value-store.ts:21

Удаляет ключ. Отсутствующий ключ не должен считаться ошибкой.

Parameters

key

string

Returns

KeyValueStoreResult<void>

---

get()

get(key): KeyValueStoreResult<T | undefined>;

Defined in: core/key-value-store.ts:17

Читает значение либо возвращает undefined, если ключ отсутствует.

Parameters

key

string

Returns

KeyValueStoreResult<T | undefined>

---

keys()?

optional keys(prefix?): KeyValueStoreResult<KeyValueStoreKeys>;

Defined in: core/key-value-store.ts:23

Перечисляет ключи, при возможности ограничивая их префиксом.

Parameters

prefix?

string

Returns

KeyValueStoreResult<KeyValueStoreKeys>

---

set()

set(key, value): KeyValueStoreResult<void>;

Defined in: core/key-value-store.ts:19

Полностью заменяет значение ключа.

Parameters

key

string

value

T

Returns

KeyValueStoreResult<void>