Skip to main content

LocalStorageManager<T>

Defined in: atomiq-sdk/src/storage-browser/LocalStorageManager.ts:9

IStorageManager implementation using browser's local storage API, this is used as general purpose key-value storage, not used for storing swaps! See IUnifiedStorage for swap storage interface.

Type Parameters​

Type Parameter
T extends StorageObject

Implements​

Constructors​

Constructor​

new LocalStorageManager<T>(storageKey): LocalStorageManager<T>;

Defined in: atomiq-sdk/src/storage-browser/LocalStorageManager.ts:24

Parameters​

ParameterTypeDescription
storageKeystringThe key-value store is stored as JSON serialized parameter of the Local Storage under the specified storageKey

Returns​

LocalStorageManager<T>

Properties​

data​

data: object = {};

Defined in: atomiq-sdk/src/storage-browser/LocalStorageManager.ts:16

In-memory cache of stored objects, keyed by hash

Index Signature​

[hash: string]: T

Implementation of​

IStorageManager.data


rawData​

rawData: object = {};

Defined in: atomiq-sdk/src/storage-browser/LocalStorageManager.ts:13

Index Signature​

[hash: string]: any

storageKey​

storageKey: string;

Defined in: atomiq-sdk/src/storage-browser/LocalStorageManager.ts:11

Methods​

init()​

init(): Promise<void>;

Defined in: atomiq-sdk/src/storage-browser/LocalStorageManager.ts:31

Initializes the storage backend

Returns​

Promise<void>

Implementation of​

IStorageManager.init


loadData()​

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

Defined in: atomiq-sdk/src/storage-browser/LocalStorageManager.ts:92

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-sdk/src/storage-browser/LocalStorageManager.ts:67

Removes an object from storage

Parameters​

ParameterTypeDescription
hashstringIdentifier of the object to remove

Returns​

Promise<void>

Implementation of​

IStorageManager.removeData


removeDataArr()​

removeDataArr(hashArr): Promise<void>;

Defined in: atomiq-sdk/src/storage-browser/LocalStorageManager.ts:79

Removes multiple objects from storage (optional batch operation)

Parameters​

ParameterTypeDescription
hashArrstring[]Array of identifiers to remove

Returns​

Promise<void>

Implementation of​

IStorageManager.removeDataArr


saveData()​

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

Defined in: atomiq-sdk/src/storage-browser/LocalStorageManager.ts:45

Saves an object to storage

Parameters​

ParameterTypeDescription
hashstringUnique identifier for the object
objectTObject to save

Returns​

Promise<void>

Implementation of​

IStorageManager.saveData


saveDataArr()​

saveDataArr(arr): Promise<void>;

Defined in: atomiq-sdk/src/storage-browser/LocalStorageManager.ts:55

Saves multiple objects to storage (optional batch operation)

Parameters​

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

Returns​

Promise<void>

Implementation of​

IStorageManager.saveDataArr