|Sven Slootweg feebee59f0||2 months ago|
|.vscode||2 months ago|
|src||2 months ago|
|.gitignore||2 months ago|
|Cargo.lock||2 months ago|
|Cargo.toml||2 months ago|
|README.md||2 months ago|
|package.json||2 months ago|
|shell.nix||2 months ago|
|test.js||2 months ago|
|yarn.lock||2 months ago|
node-veilid: Node.js bindings for Veilid
This project was bootstrapped by create-neon.
Installing node-veilid 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.
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
After building node-veilid, you can explore its exports at the Node REPL:
$ npm install $ node > require('.').hello() "hello node"
In the project directory, you can run:
Installs the project, including running
npm run build.
Builds the Node addon (
index.node) from source.
npm run build -- --feature=beetle
The directory structure of this project is:
node-veilid/ ├── Cargo.toml ├── README.md ├── index.node ├── package.json ├── src/ | └── lib.rs └── target/
The Cargo manifest file, which informs the
The Node addon—i.e., a binary Node module—generated by building the project. This is the main module for this package, as dictated by the
"main" key in
Under the hood, a Node addon is a dynamically-linked shared object. The
"build" script produces this file by copying it from within the
target/ directory, which is where the Rust build produces the shared object.
The npm manifest file, which informs the
The directory tree containing the Rust source code for the project.
The Rust library's main module.
Binary artifacts generated by the Rust build.
To learn more about Neon, see the Neon documentation.
To learn more about Rust, see the Rust documentation.
To learn more about Node, see the Node documentation.