Keyv File

https://github.com/zaaack/keyv-file

Admin

Keyv File is a file storage adapter for Keyv, serializing data fast and small using msgpack for...

Tokens:577

Snippets:8

Trust Score:8.7

License:MIT

Update:4 months ago

Show doc for...

Tokens:

Raw

### Install keyv and keyv-file

Source: https://github.com/zaaack/keyv-file/blob/master/README.md

Install the necessary packages for using keyv-file with Keyv.

```shell
npm install --save keyv keyv-file
```

--------------------------------

### Direct usage with KeyvFile and custom fields

Source: https://github.com/zaaack/keyv-file/blob/master/README.md

Demonstrates direct usage of KeyvFile with custom field management using the 'makeField' utility. Allows for specific field operations like get, set, and delete.

```typescript
import KeyvFile, { makeField } from 'keyv-file'

class Kv extends KeyvFile {
  constructor() {
    super({
      filename: './db.json'
    })
  }
  someField = makeField(this, 'field_key')
}

export const kv = new Kv

kv.someField.get(1) // empty return default value 1
kv.someField.set(2) // set value 2
kv.someField.get() // return saved value 2
kv.someField.delete() // delete field
```

--------------------------------

### Initialize Keyv with KeyvFile adapter

Source: https://github.com/zaaack/keyv-file/blob/master/README.md

Basic initialization of Keyv using the default KeyvFile store.

```javascript
const Keyv = require('keyv')
const { KeyvFile } = require('keyv-file')

const keyv = new Keyv ({
  store: new KeyvFile()
});
```

--------------------------------

### Initialize Keyv with custom KeyvFile options

Source: https://github.com/zaaack/keyv-file/blob/master/README.md

Initialize Keyv with a KeyvFile store configured with custom options for filename, expiration check delay, write delay, and serialization functions.

```javascript
const Keyv = require('keyv')
const { KeyvFile } = require('keyv-file')

const customKeyv = new Keyv ({
  store: new KeyvFile ({
    filename: `${os.tmpdir()}/keyv-file/default.json`, // 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.
    encode: JSON.stringify, // serialize function
    decode: JSON.parse // deserialize function
  })
})
```

Tokens:

Raw