Creates a key/value store
Promise.<KV>Instantiate the kv service
Promise.<void>
* [.get(key)](#KV+get) ⇒ Promise.<\*>
* [.delete(key)](#KV+delete) ⇒ Promise.<void>
* [.getSet(key, value, [ttl])](#KV+getSet) ⇒ Promise.<\*>
* [.getDelete(key)](#KV+getDelete) ⇒ Promise.<\*>
* [.bulkSet(keys, values, [ttls])](#KV+bulkSet) ⇒ Promise.<void>
* [.bulkGet(keys)](#KV+bulkGet) ⇒ Promise.<Array.<\*>>
* [.bulkDelete(keys)](#KV+bulkDelete) ⇒ Promise.<void>
### kV.set(key, value, [ttl]) ⇒ Promise.<void>
Set a value in the store
**Kind**: instance method of [KV](#KV)
**Returns**: Promise.<void> - A promise to be resolved when the value is stored.
| Param | Type | Description |
| --- | --- | --- |
| key | String | The key to store the value at |
| value | \* | The value to store |
| [ttl] | number | The duration in milliseconds the value remains valid |
**Example**
```js
kv.set('hello', 'world');
.then(() => console.log('Stored!'));
// Prints: Stored!
```
### kV.get(key) ⇒ Promise.<\*>
Get a value from the store
**Kind**: instance method of [KV](#KV)
**Returns**: Promise.<\*> - A promise that resolve to the actual value.
| Param | Type | Description |
| --- | --- | --- |
| key | String | The key that map to the value |
**Example**
```js
kv.get('hello');
.then((value) => console.log(value));
// Prints: world
```
### kV.delete(key) ⇒ Promise.<void>
Delete a value from the store
**Kind**: instance method of [KV](#KV)
**Returns**: Promise.<void> - A promise that resolve once the value is deleted.
| Param | Type | Description |
| --- | --- | --- |
| key | String | The keyof the deleted value |
**Example**
```js
kv.delete('hello');
.then((value) => console.log('Deleted!'));
// Prints: Deleted!
```
### kV.getSet(key, value, [ttl]) ⇒ Promise.<\*>
Set a value and get the previous one
**Kind**: instance method of [KV](#KV)
**Returns**: Promise.<\*> - A promise that resolve to the previous value.
| Param | Type | Description |
| --- | --- | --- |
| key | String | The key that map to the value |
| value | \* | The new value to store |
| [ttl] | number | The duration in milliseconds the value remains valid |
**Example**
```js
kv.getSet('hello', 'folks');
.then((value) => console.log(value));
// Prints: world
```
### kV.getDelete(key) ⇒ Promise.<\*>
Get a value from the store and delete it
**Kind**: instance method of [KV](#KV)
**Returns**: Promise.<\*> - A promise that resolve to the actual value.
| Param | Type | Description |
| --- | --- | --- |
| key | String | The key that map to the value |
**Example**
```js
kv.getDelete('hello');
.then((value) => console.log(value));
// Prints: world
```
### kV.bulkSet(keys, values, [ttls]) ⇒ Promise.<void>
Set a several values in the store
**Kind**: instance method of [KV](#KV)
**Returns**: Promise.<void> - A promise to be resolved when the values are stored.
| Param | Type | Description |
| --- | --- | --- |
| keys | Array.String | The keys to store the values at |
| values | Array | The values to store |
| [ttls] | Array.number | The duration in milliseconds each values remains valid |
**Example**
```js
kv.bulkSet(['hello', 'foo'], ['world', 'bar']);
.then(() => console.log('Stored!'));
// Prints: Stored!
```
### kV.bulkGet(keys) ⇒ Promise.<Array.<\*>>
Get a several values from the store
**Kind**: instance method of [KV](#KV)
**Returns**: Promise.<Array.<\*>> - A promise to be resolved when the values
are retrieved.
| Param | Type | Description |
| --- | --- | --- |
| keys | Array.String | The keys to retrieve the values |
**Example**
```js
kv.bulkGet(['hello', 'foo']);
.then((values) => console.log(values));
// Prints: ['world', 'bar']
```
### kV.bulkDelete(keys) ⇒ Promise.<void>
Delete values for several keys from the store
**Kind**: instance method of [KV](#KV)
**Returns**: Promise.<void> - A promise to be resolved when the values
are deleted.
| Param | Type | Description |
| --- | --- | --- |
| keys | Array.String | The keys for which to delete the values |
**Example**
```js
kv.bulkDelete(['hello', 'foo']);
.then((values) => console.log('Deleted!'));
// Prints: Deleted!
```
## initKV(services) ⇒ [Promise.<KV>](#KV)
Instantiate the kv service
**Kind**: global function
**Returns**: [Promise.<KV>](#KV) - A promise of the kv service
| Param | Type | Description |
| --- | --- | --- |
| services | Object | The services to inject |
| services.delay | function | A delaying function |
| services.time | function | A timing function |
| [services.log] | function | A logging function |
| [services.KV_TTL] | Number | The store time to live |
| [services.KV_STORE] | Map | The store for values as a simple object, it is useful to get a synchronous access to the store in tests for example. |
**Example**
```js
import initKV from 'memory-kv-store';
const kv = await initKV({
delay: Promise.delay.bind(Promise),
});
```
# Authors
- [Nicolas Froidure](http://insertafter.com/en/index.html)
# License
[MIT](https://github.com/nfroidure/memory-kv-store/blob/main/LICENSE)
---
_Source: https://npm.io/package/memory-kv-store · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._