@xylabs/storage

[![logo][]](https://xylabs.com)

[![main-build][]][main-build-link]
[![npm-badge][]][npm-link]
[![npm-downloads-badge][]][npm-link]
[![jsdelivr-badge][]][jsdelivr-link]
[![npm-license-badge][]](LICENSE)
[![codacy-badge][]][codacy-link]
[![codeclimate-badge][]][codeclimate-link]
[![snyk-badge][]][snyk-link]
[![socket-badge][]][socket-link]

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/storage

Interfaces

- ReadonlyKeyValueStore
- KeyValueStore

$3

### KeyValueStore

@xylabs/storage

A read/write storage device.

Extends

- ReadonlyKeyValueStore\<TValue, TKey\>

Type Parameters

$3

TValue

$3

TKey = string

Methods

$3

``ts get(key): Promisable;`

Returns a promise that resolves to the value for the given key.

`$3`

#### key

TKey

The key to get the value for.

`$3`

Promisable\<undefined \| TValue\>

`$3`

ReadonlyKeyValueStore.get

*

`$3`

`ts optional keys(): Promisable;`

The keys an array of keys.

`$3`

Promisable\<TKey[]\>

`$3`

ReadonlyKeyValueStore.keys

*

`$3`

`ts optional clear(): Promisable;`

`$3`

Promisable\<void\>

*

`$3`

`ts delete(key): Promisable;`

`$3`

#### key

TKey

`$3`

Promisable\<void\>

*

`$3`

`ts set(key, value): Promisable;`

`$3`

#### key

TKey

#### value

TValue

`$3`

Promisable\<void\>

### ReadonlyKeyValueStore

@xylabs/storage

*

A readonly storage device.

`Extended by`

- KeyValueStore

`Type Parameters`

`$3`

TValue

`$3`

TKey = string

`Methods`

`$3`

`ts get(key): Promisable;`

Returns a promise that resolves to the value for the given key.

`$3`

#### key

TKey

The key to get the value for.

`$3`

Promisable\<undefined \| TValue\>

*

`$3`

`ts optional keys(): Promisable;`

The keys an array of keys.

`$3`

Promisable\<TKey`[]\>

Part of sdk-js

Maintainers

- Arie Trouw (arietrouw.com)
- Matt Jones
- Joel Carter
- Jordan Trouw

License

> See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs

[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg

[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
[npm-badge]: https://img.shields.io/npm/v/@xylabs/storage.svg
[npm-link]: https://www.npmjs.com/package/@xylabs/storage
[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json

[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/storage
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/storage

[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/storage/badge
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/storage

[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/storage
[socket-link]: https://socket.dev/npm/package/@xylabs/storage

@xylabs/storage

[![logo][]](https://xylabs.com)

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/storage

Interfaces

- ReadonlyKeyValueStore
- KeyValueStore

$3

### KeyValueStore

@xylabs/storage

A read/write storage device.

Extends

- ReadonlyKeyValueStore\<TValue, TKey\>

Type Parameters

$3

TValue

$3

TKey = string

Methods

$3

``ts get(key): Promisable;`

Returns a promise that resolves to the value for the given key.

`$3`

#### key

TKey

The key to get the value for.

`$3`

Promisable\<undefined \| TValue\>

`$3`

ReadonlyKeyValueStore.get

*

`$3`

`ts optional keys(): Promisable;`

The keys an array of keys.

`$3`

Promisable\<TKey[]\>

`$3`

ReadonlyKeyValueStore.keys

*

`$3`

`ts optional clear(): Promisable;`

`$3`

Promisable\<void\>

*

`$3`

`ts delete(key): Promisable;`

`$3`

#### key

TKey

`$3`

Promisable\<void\>

*

`$3`

`ts set(key, value): Promisable;`

`$3`

#### key

TKey

#### value

TValue

`$3`

Promisable\<void\>

### ReadonlyKeyValueStore

@xylabs/storage

*

A readonly storage device.

`Extended by`

- KeyValueStore

`Type Parameters`

`$3`

TValue

`$3`

TKey = string

`Methods`

`$3`

`ts get(key): Promisable;`

Returns a promise that resolves to the value for the given key.

`$3`

#### key

TKey

The key to get the value for.

`$3`

Promisable\<undefined \| TValue\>

*

`$3`

`ts optional keys(): Promisable;`

The keys an array of keys.

`$3`

Promisable\<TKey`[]\>

Part of sdk-js

Maintainers

- Arie Trouw (arietrouw.com)
- Matt Jones
- Joel Carter
- Jordan Trouw

License

> See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs

[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg

[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/storage
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/storage

[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/storage/badge
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/storage

[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/storage
[socket-link]: https://socket.dev/npm/package/@xylabs/storage

@xylabs/storage

@xylabs/storage

Reference

Interfaces

$3

Extends

Type Parameters

$3

$3

Methods

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Extended by

Type Parameters

$3

$3

Methods

$3

$3

$3

$3

$3

Maintainers

License

Credits

@xylabs/storage

@xylabs/storage

Reference

Interfaces

$3

Extends

Type Parameters

$3

$3

Methods

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Extended by

Type Parameters

$3

$3

Methods

$3

$3

$3

$3

$3

Maintainers

License

Credits

Dist Tags

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Extended by`

`Type Parameters`

`$3`

`$3`

`Methods`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Extended by`

`Type Parameters`

`$3`

`$3`

`Methods`

`$3`

`$3`

`$3`

`$3`

`$3`