keyv-file

keyv-file

File storage adapter for Keyv, using msgpack 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

npm install --save keyv keyv-file

Usage

const Keyv = require('keyv')
const KeyvFile = require('keyv-file')

const keyv = new Keyv({
  store: new KeyvFile()
});
// More options with default value:
const customKeyv = new Keyv({
  store: newKeyvFile({
    filename: `${os.tmpdir()}/keyv-file/default-rnd-${Math.random().toString(36).slice(2)}.msgpack` // the file path to store the data
    expiredCheckDelay: 24 * 3600 * 1000, // ms, check and remove expired data in each ms
    writeDelay: 100, // ms, batch write to disk in a specific duration, enhance write performance.
  })
})

License

MIT © Zaaack