keyv-file

File storage adapter for Keyv, using json to serialize data fast and small.

File storage adapter for Keyv.

TTL functionality is handled internally by interval scan, don't need to panic about expired data take too much space.

Install

1npm install --save keyv keyv-file

Usage

Using with keyv

1const Keyv = require('keyv')
2const { KeyvFile } = require('keyv-file')
3
4const keyv = new Keyv({
5  store: new KeyvFile()
6});
7// More options with default value:
8const customKeyv = new Keyv({
9  store: new KeyvFile({
10    filename: `${os.tmpdir()}/keyv-file/default-rnd-${Math.random().toString(36).slice(2)}.json`, // the file path to store the data
11    expiredCheckDelay: 24 * 3600 * 1000, // ms, check and remove expired data in each ms
12    writeDelay: 100, // ms, batch write to disk in a specific duration, enhance write performance.
13    encode: JSON.stringify, // serialize function
14    decode: JSON.parse // deserialize function
15  })
16})

Using directly

1import KeyvFile, { makeField } from 'keyv-file'
2
3class Kv extends KeyvFile {
4  constructor() {
5    super({
6      filename: './db.json'
7    })
8  }
9  someField = makeField(this, 'field_key')
10}
11
12export const kv = new Kv
13
14kv.someField.get(1) // empty return default value 1
15kv.someField.set(2) // set value 2
16kv.someField.get() // return saved value 2
17kv.someField.delete() // delete field

License

MIT