napi-rs
This project was initialized from xray
A minimal library for building compiled Node.js
add-ons in Rust
.
Ecosystem
Platform Support
node12 | node14 | node16 | |
---|---|---|---|
Windows x64 | ✓ | ✓ | ✓ |
Windows x86 | ✓ | ✓ | ✓ |
Windows arm64 | ✓ | ✓ | ✓ |
macOS x64 | ✓ | ✓ | ✓ |
macOS aarch64 | ✓ | ✓ | ✓ |
Linux x64 gnu | ✓ | ✓ | ✓ |
Linux x64 musl | ✓ | ✓ | ✓ |
Linux aarch64 gnu | ✓ | ✓ | ✓ |
Linux aarch64 musl | ✓ | ✓ | ✓ |
Linux arm gnueabihf | ✓ | ✓ | ✓ |
Linux aarch64 android | ✓ | ✓ | ✓ |
FreeBSD x64 | ✓ | ✓ | ✓ |
This library depends on Node-API and requires Node@10.0.0
or later.
We already have some packages written by napi-rs
: node-rs
One nice feature is that this crate allows you to build add-ons purely with the Rust/JavaScript
toolchain and without involving node-gyp
.
Taste
You can start from package-template to play with
napi-rs
Define JavaScript functions
extern crate napi;
// import the preludes
use *;
/// module registerion is done by the runtime, no need to explicitly do it now.
/// use `Fn`, `FnMut` or `FnOnce` traits to defined JavaScript callbacks
/// the return type of callbacks can only be `Result`.
/// or, define the callback signature in where clause
Checkout more examples in examples folder
Building
This repository is a Cargo
crate. Any napi-based add-on should contain Cargo.toml
to make it a Cargo crate.
In your Cargo.toml
you need to set the crate-type
to "cdylib"
so that cargo builds a C-style shared library that can be dynamically loaded by the Node executable. You'll also need to add this crate as a dependency.
[]
= "awesome"
[]
= ["cdylib"]
[]
= "2"
= "2"
[]
= "1"
And create build.rs
in your own project:
// build.rs
extern crate napi_build;
So far, the napi
build script has only been tested on macOS
Linux
Windows x64 MSVC
and FreeBSD
.
Install the @napi-rs/cli
to help you build your Rust
codes and copy Dynamic lib
file to .node
file in case you can require
it in your program.
Then you can require your native binding:
require
The module_name
would be your package
name in your Cargo.toml
.
xxx => ./xxx.node
xxx-yyy => ./xxx_yyy.node
You can also copy Dynamic lib
file to an appointed location:
There are documents which contains more details about the @napi-rs/cli
usage.
Testing
Because libraries that depend on this crate must be loaded into a Node executable in order to resolve symbols, all tests are written in JavaScript in the test_module
subdirectory.
To run tests:
Related projects
Features table
Rust Type | Node Type | NAPI Version | Minimal Node version |
---|---|---|---|
u32 | Number | 1 | v8.0.0 |
i32/i64 | Number | 1 | v8.0.0 |
f64 | Number | 1 | v8.0.0 |
bool | Boolean | 1 | v8.0.0 |
String/&'a str | String | 1 | v8.0.0 |
Latin1String | String | 1 | v8.0.0 |
UTF16String | String | 1 | v8.0.0 |
Object | Object | 1 | v8.0.0 |
Array | Array | 1 | v8.0.0 |
Vec | Array | 1 | v8.0.0 |
Buffer | Buffer | 1 | v8.0.0 |
Null | null | 1 | v8.0.0 |
Undefined/() | undefined | 1 | v8.0.0 |
Result<()> | Error | 1 | v8.0.0 |
T: Fn(...) -> Result | function | 1 | v8.0.0 |
(NOT YET) | global | 1 | v8.0.0 |
(NOT YET) | Symbol | 1 | v8.0.0 |
(NOT YET) | Promise | 1 | b8.5.0 |
(NOT YET) | ArrayBuffer/TypedArray | 1 | v8.0.0 |
(NOT YET) | threadsafe function | 4 | v10.6.0 |
(NOT YET) | BigInt | 6 | v10.7.0 |