You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
122 lines
3.4 KiB
Markdown
122 lines
3.4 KiB
Markdown
# node-veilid
|
|
|
|
**node-veilid:** Node.js bindings for Veilid
|
|
|
|
This project was bootstrapped by [create-neon](https://www.npmjs.com/package/create-neon).
|
|
|
|
## Installing node-veilid
|
|
|
|
Installing node-veilid requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support).
|
|
|
|
You can install the project with npm. In the project directory, run:
|
|
|
|
```sh
|
|
$ npm install
|
|
```
|
|
|
|
This fully installs the project, including installing any dependencies and running the build.
|
|
|
|
## Building node-veilid
|
|
|
|
If you have already installed the project and only want to run the build, run:
|
|
|
|
```sh
|
|
$ npm run build
|
|
```
|
|
|
|
This command uses the [cargo-cp-artifact](https://github.com/neon-bindings/cargo-cp-artifact) utility to run the Rust build and copy the built library into `./index.node`.
|
|
|
|
## Exploring node-veilid
|
|
|
|
After building node-veilid, you can explore its exports at the Node REPL:
|
|
|
|
```sh
|
|
$ npm install
|
|
$ node
|
|
> require('.').hello()
|
|
"hello node"
|
|
```
|
|
|
|
## 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.
|
|
|
|
Additional [`cargo build`](https://doc.rust-lang.org/cargo/commands/cargo-build.html) arguments may be passed to `npm build` and `npm build-*` commands. For example, to enable a [cargo feature](https://doc.rust-lang.org/cargo/reference/features.html):
|
|
|
|
```
|
|
npm run build -- --feature=beetle
|
|
```
|
|
|
|
#### `npm build-debug`
|
|
|
|
Alias for `npm build`.
|
|
|
|
#### `npm build-release`
|
|
|
|
Same as [`npm build`](#npm-build) but, builds the module with the [`release`](https://doc.rust-lang.org/cargo/reference/profiles.html#release) profile. Release builds will compile slower, but run faster.
|
|
|
|
### `npm test`
|
|
|
|
Runs the unit tests by calling `cargo test`. You can learn more about [adding tests to your Rust code](https://doc.rust-lang.org/book/ch11-01-writing-tests.html) from the [Rust book](https://doc.rust-lang.org/book/).
|
|
|
|
## Project Layout
|
|
|
|
The directory structure of this project is:
|
|
|
|
```
|
|
node-veilid/
|
|
├── Cargo.toml
|
|
├── README.md
|
|
├── index.node
|
|
├── package.json
|
|
├── src/
|
|
| └── lib.rs
|
|
└── target/
|
|
```
|
|
|
|
### Cargo.toml
|
|
|
|
The Cargo [manifest file](https://doc.rust-lang.org/cargo/reference/manifest.html), which informs the `cargo` command.
|
|
|
|
### README.md
|
|
|
|
This file.
|
|
|
|
### index.node
|
|
|
|
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 `package.json`.
|
|
|
|
Under the hood, a [Node addon](https://nodejs.org/api/addons.html) is a [dynamically-linked shared object](https://en.wikipedia.org/wiki/Library_(computing)#Shared_libraries). The `"build"` script produces this file by copying it from within the `target/` directory, which is where the Rust build produces the shared object.
|
|
|
|
### package.json
|
|
|
|
The npm [manifest file](https://docs.npmjs.com/cli/v7/configuring-npm/package-json), which informs the `npm` command.
|
|
|
|
### src/
|
|
|
|
The directory tree containing the Rust source code for the project.
|
|
|
|
### src/lib.rs
|
|
|
|
The Rust library's main module.
|
|
|
|
### target/
|
|
|
|
Binary artifacts generated by the Rust build.
|
|
|
|
## Learn More
|
|
|
|
To learn more about Neon, see the [Neon documentation](https://neon-bindings.com).
|
|
|
|
To learn more about Rust, see the [Rust documentation](https://www.rust-lang.org).
|
|
|
|
To learn more about Node, see the [Node documentation](https://nodejs.org).
|