Skip to main content

KeyValueStorageManager<T>

Defined in: atomiq-storage-memory-indexed-kv/src/KeyValueStorageManager.ts:9

Simple IStorageManager adapter built on top of any IKeyValueStorage backend.

This is intended for chain-storage style data where values are accessed by id and no in-memory indexes are required.

Type Parameters

Type ParameterDefault type
T extends StorageObjectStorageObject

Implements

Constructors

Constructor

new KeyValueStorageManager<T>(storageBackend): KeyValueStorageManager<T>;

Defined in: atomiq-storage-memory-indexed-kv/src/KeyValueStorageManager.ts:20

Parameters

ParameterType
storageBackendIKeyValueStorage<boolean>

Returns

KeyValueStorageManager<T>

Properties

data

data: object = {};

Defined in: atomiq-storage-memory-indexed-kv/src/KeyValueStorageManager.ts:13

In-memory cache of stored objects, keyed by hash

Index Signature

[hash: string]: T

Implementation of

IStorageManager.data


removeDataArr()?

optional removeDataArr: (keys) => Promise<void>;

Defined in: atomiq-storage-memory-indexed-kv/src/KeyValueStorageManager.ts:18

Removes multiple objects from storage (optional batch operation)

Parameters

ParameterTypeDescription
keysstring[]Array of identifiers to remove

Returns

Promise<void>

Implementation of

IStorageManager.removeDataArr


saveDataArr()?

optional saveDataArr: (values) => Promise<void>;

Defined in: atomiq-storage-memory-indexed-kv/src/KeyValueStorageManager.ts:17

Saves multiple objects to storage (optional batch operation)

Parameters

ParameterTypeDescription
valuesobject[]Array of id-object pairs to save

Returns

Promise<void>

Implementation of

IStorageManager.saveDataArr


storageBackend

storageBackend: IKeyValueStorage<boolean>;

Defined in: atomiq-storage-memory-indexed-kv/src/KeyValueStorageManager.ts:11

Methods

init()

init(): Promise<void>;

Defined in: atomiq-storage-memory-indexed-kv/src/KeyValueStorageManager.ts:43

Initializes the storage backend

Returns

Promise<void>

Implementation of

IStorageManager.init


loadData()

loadData(type): Promise<T[]>;

Defined in: atomiq-storage-memory-indexed-kv/src/KeyValueStorageManager.ts:57

Loads all stored objects and deserializes them using the provided constructor

Parameters

ParameterTypeDescription
type(data) => TConstructor function to instantiate each object

Returns

Promise<T[]>

Array of deserialized objects

Implementation of

IStorageManager.loadData


removeData()

removeData(hash): Promise<void>;

Defined in: atomiq-storage-memory-indexed-kv/src/KeyValueStorageManager.ts:52

Removes an object from storage

Parameters

ParameterTypeDescription
hashstringIdentifier of the object to remove

Returns

Promise<void>

Implementation of

IStorageManager.removeData


saveData()

saveData(hash, object): Promise<void>;

Defined in: atomiq-storage-memory-indexed-kv/src/KeyValueStorageManager.ts:47

Saves an object to storage

Parameters

ParameterTypeDescription
hashstringUnique identifier for the object
objectTObject to save

Returns

Promise<void>

Implementation of

IStorageManager.saveData