@xylabs/storage


Base functionality used throughout XY Labs TypeScript/JavaScript libraries
Reference
@xylabs/storage
Interfaces
interfaces
KeyValueStore
@xylabs/storage
A read/write storage device.
Extends
Type Parameters
TValue
TValue
TKey
TKey = string
Methods
get()
get(key): Promisable<undefined | TValue>;
Returns a promise that resolves to the value for the given key.
Parameters
key
TKey
The key to get the value for.
Returns
Promisable<undefined | TValue>
Inherited from
ReadonlyKeyValueStore.get
keys()?
optional keys(): Promisable<TKey[]>;
The keys an array of keys.
Returns
Promisable<TKey[]>
Inherited from
ReadonlyKeyValueStore.keys
clear()?
optional clear(): Promisable<void>;
Returns
Promisable<void>
delete()
delete(key): Promisable<void>;
Parameters
key
TKey
Returns
Promisable<void>
set()
set(key, value): Promisable<void>;
Parameters
key
TKey
value
TValue
Returns
Promisable<void>
ReadonlyKeyValueStore
@xylabs/storage
A readonly storage device.
Extended by
Type Parameters
TValue
TValue
TKey
TKey = string
Methods
get()
get(key): Promisable<undefined | TValue>;
Returns a promise that resolves to the value for the given key.
Parameters
key
TKey
The key to get the value for.
Returns
Promisable<undefined | TValue>
keys()?
optional keys(): Promisable<TKey[]>;
The keys an array of keys.
Returns
Promisable<TKey[]>
Part of sdk-js
Maintainers
License
See the LICENSE file for license details
Credits
Made with š„ and āļø by XYLabs