KeyvJetpack

Simple filesystem based storage for the Keyv key-value store; FS-Jetpackfs-jetpack is used due to unadulterated laziness.

The existing keyv-file module had some quirky decisions — in particular, every namespace was stored in a single JSON file, making large piles of data a little punishing.

Usage

Create a new KeyV instance and use a KeyFsStore instance as its store option. That's it.

1import { KeyvFsStore } from 'keyv-jetpack';
2import { Keyv } from 'keyv';
3
4const kv = new Keyv({ store: new KeyFsStore() });
5
6await kv.set('key', { data: 'stuff goes here…' });
7console.log(await kv.get('key')); // { data: 'stuff goes here…' };
8
9await kv.clear(); // Directory deleted

Thanks to KeyV, things like expiring values and such are handled transparently. A custom storage directory can be used, or multiple namespaces to avoid collisions.

1import { KeyvFsStore } from 'keyv-fs';
2import { Keyv } from 'keyv';
3
4const kv = new Keyv({ store: new KeyFsStore({
5  rootDir: './custom/storage'
6}) });

By default, a keyv directory in the systemp temp dir will be used.