@xylabs/storage
Advanced tools
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
@xylabs/storage
| Interface | Description |
|---|---|
| ReadonlyKeyValueStore | A readonly storage device. |
| KeyValueStore | A read/write storage device. |
A read/write storage device.
ReadonlyKeyValueStore<TValue, TKey>| Type Parameter | Default type |
|---|---|
TValue | - |
TKey | string |
get(key: TKey): Promisable<TValue | undefined>;
Returns a promise that resolves to the value for the given key.
| Parameter | Type | Description |
|---|---|---|
key | TKey | The key to get the value for. |
Promisable<TValue | undefined>
optional keys(): Promisable<TKey[]>;
The keys an array of keys.
Promisable<TKey[]>
optional clear(): Promisable<void>;
Removes all entries from the store.
Promisable<void>
delete(key: TKey): Promisable<void>;
Deletes the entry with the given key.
| Parameter | Type | Description |
|---|---|---|
key | TKey | The key of the entry to delete |
Promisable<void>
set(key: TKey, value: TValue): Promisable<void>;
Sets a value for the given key, creating or updating the entry.
| Parameter | Type | Description |
|---|---|---|
key | TKey | The key to set |
value | TValue | The value to store |
Promisable<void>
A readonly storage device.
| Type Parameter | Default type |
|---|---|
TValue | - |
TKey | string |
get(key: TKey): Promisable<TValue | undefined>;
Returns a promise that resolves to the value for the given key.
| Parameter | Type | Description |
|---|---|---|
key | TKey | The key to get the value for. |
Promisable<TValue | undefined>
optional keys(): Promisable<TKey[]>;
The keys an array of keys.
Promisable<TKey[]>
Part of sdk-js
See the LICENSE file for license details
FAQs
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
The npm package @xylabs/storage receives a total of 851 weekly downloads. As such, @xylabs/storage popularity was classified as not popular.
We found that @xylabs/storage demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.Ā It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Six malicious Packagist packages posing as OphimCMS themes contain trojanized jQuery that exfiltrates URLs, injects ads, and loads FUNNULL-linked redirects.
Security News
The GCVE initiative operated by CIRCL has officially opened its publishing ecosystem, letting organizations issue and share vulnerability identifiers without routing through a central authority.
Security News
The project is retiring its odd/even release model in favor of a simpler annual cadence where every major version becomes LTS.