← All packages

API reference

@searsuite/sear-foundation-storage

Abstract key-value storage contracts and in-memory adapters.

4 exportsderived from source

classDataStoragesource ↗
class DataStorage<U, T, S>

DataStorage public API.

constructorconstructor
DataStorage<U, T, S>(storage: S): DataStorage<U, T, S>

Creates a DataStorage instance.

storage: S
propertysymbolstatic
readonly symbol: symbol

DI token for resolving DataStorage.

methoddelete
delete(key: U): void

Deletes the requested entry.

key: U
methodget
get(key: U): T | undefined

Returns the value.

key: U
methodset
set(key: U, value: T): void

Updates the value.

key: U
value: T
classDataStorageFactorysource ↗
class DataStorageFactory<T>

Factory contract for creating data storage instances.

constructorconstructor
DataStorageFactory<T>(): DataStorageFactory<T>
methodcreate
create(): T

Creates the value.

classMapDataStoragesource ↗
class MapDataStorage<U, T> extends DataStorage<U, T, Map<U, T>>

Map-backed DataStorage implementation.

constructorconstructor
MapDataStorage<U, T>(): MapDataStorage<U, T>

Creates a MapDataStorage instance.

methoddelete
delete(key: U): void

Deletes the requested entry.

key: U
methodget
get(key: U): T | undefined

Returns the value.

key: U
methodset
set(key: U, value: T): void

Updates the value.

key: U
value: T
Inherited members 1

Inherited from DataStorage.

classMapDataStorageFactorysource ↗
class MapDataStorageFactory<U, T> extends DataStorageFactory<MapDataStorage<U, T>>

MapDataStorageFactory public API.

constructorconstructor
MapDataStorageFactory<U, T>(): MapDataStorageFactory<U, T>
methodcreate
create(): MapDataStorage<U, T>

Creates the value.