tikv-client v0.0.0

client-node

client-node: A TiKV client in Node.js.

This project was bootstrapped by create-neon.

Installing client-node

Installing client-node requires a supported version of Node and Rust.

You can install the project with npm. In the project directory, run:

$ npm install

This fully installs the project, including installing any dependencies and running the build.

Building client-node

If you have already installed the project and only want to run the build, run:

$ npm run build

This command uses the cargo-cp-artifact utility to run the Rust build and copy the built library into ./index.node.

Exploring client-node

After building client-node, you can explore its exports at the Node REPL:

$ npm install
$ node transaction_app.js
v4
v3
[ 'k1', 'v1' ]
[ 'k4', 'v4' ]

Available Scripts

In the project directory, you can run:

npm install

Installs the project, including running npm run build.

npm build

Builds the Node addon (index.node) from source.

npm test

Runs the unit tests by calling cargo test. You can learn more about adding tests to your Rust code from the Rust book.