Rust bindings for writing safe and fast native Node.js modules.
Once you have the platform dependencies installed, getting started is as simple as:
$ npm init neon my-project
Then see the Hello World guide for writing your first Hello World in Neon!
Note: This will create a new project with the
napi-backend and some documentation may not be up to date.
See our Neon fundamentals docs and our API docs.
N-API Migration Guide
We've ported Neon to a new backend based on N-API, which will be the basis for Neon 1.0.
Read the new migration guide to learn how to port your Neon projects to N-API!
|Node 12||Node 14||Node 16|
Support for LTS versions of Node and current are expected. If you're using a different version of Node and believe it should be supported, let us know.
Neon supports Rust stable version 1.18 and higher. We test on the latest stable, beta, and nightly versions of Rust.
For more examples, see our examples repo.
The Neon community is just getting started and there's tons of fun to be had. Come play! :)
The Rust Bindings community Slack is open to all; use the Slackin app to receive an invitation.
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.