nodejs-mmkv

Base on Tencent MMKV high-performance key-value storage framework. Implement Node.js.

Dependencies

- Node.js v16.x, NAPI version 8
- cmake
- C++

Install

``
npm install --save-dev nodejs-mmkv

// or

yarn add nodejs-mmkv -S
`

You can use it on Electron. The first step to setup cmake compile configuration:

`
npm config set cmake_node_runtime="electron" # eg: node|iojs|nw|electron
npm config set cmake_node_runtimeversion="x.y.z" # eg: 18.3.5
npm config set cmake_node_arch="x64" # eg: x64|ia32|arm
`

and run command on your project

`bash
yarn install

// or

npm install
`

Usage

`bash
const MMKVModule = require("nodejs-mmkv");
const path = require("path");

const mmkv = new MMKVModule({
rootDir: path.join(__dirname, "./mmkv"),
id: "com.node.mmkv",
});

// and you can create multiple instance
const logMMKV = new MMKVModule({
rootDir: path.join(__dirname, "./mmkv"),
id: "com.app.log",
});
`

API

$3

MMKVModule constructor, options is required.

options properties:

- rootDir: File saved path.[required]
- id: mmap id, default: mmkv.default[optional]
- multiProcess: Enable multi process, default: false[optional]
- cryptKey: encryption key[optional]
- logLevel: log level, default: info`[optional]

$3

Set a string value to storage.

$3

Get a string value from storage.

$3

Set a boolean value to storage.

$3

Get a boolean value from storage.

$3

Set a number value to storage.

$3

Get a number value from storage.

$3

Check if the given key exists in storage.

$3

Get all keys from storage.

$3

Remove given key and value in storage.

$3

Clear memory cache.

$3

Clear all keys and values in storage.

License

This library is licensed under the MIT license.