pmemkv-nodejs

Node.js bindings for pmemkv. All known issues and limitations are logged as GitHub issues.

⚠️ Discontinuation of the project

The pmemkv-nodejs project will no longer be maintained by Intel.

• Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.
• Intel no longer accepts patches to this project.
• If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the open source software community, please create your own fork of this project.
• You will find more information here.

Dependencies

• Node.js 6.10 or higher
• PMDK - native persistent memory libraries
• pmemkv - native key/value library
• node-addon-api, node-bindings, node-gyp - for native library integration
• Used only for testing:
  • chai - test assertion library
  • chai-string - string assertion library
  • mocha - test framework

Installation

Start by installing pmemkv on your system.

Clone the pmemkv-nodejs tree:

git clone https://github.com/pmem/pmemkv-nodejs.git
cd pmemkv-nodejs

Add npm modules to your project (install the dependencies listed in package.json in the local node_modules folder):

npm install

Testing

This library includes a set of automated tests that exercise all functionality.

LD_LIBRARY_PATH=path_to_your_libs npm test

Example

We are using /dev/shm to emulate persistent memory in example.

Example can be found within this repository in examples directory. To execute the example:

PMEM_IS_PMEM_FORCE=1 node basic_example.js