#neon #runtime #addon

neon-runtime

Bindings to the Node.js native addon API, used by the Neon implementation

35 releases

0.10.1 May 23, 2022
0.10.0 Mar 7, 2022
0.10.0-alpha.3 Dec 8, 2021
0.10.0-alpha.2 Sep 17, 2021
0.1.13 Feb 20, 2017

#88 in Profiling

Download history 10961/week @ 2022-08-10 12241/week @ 2022-08-17 12248/week @ 2022-08-24 12947/week @ 2022-08-31 15523/week @ 2022-09-07 12332/week @ 2022-09-14 12031/week @ 2022-09-21 15256/week @ 2022-09-28 12106/week @ 2022-10-05 13032/week @ 2022-10-12 12146/week @ 2022-10-19 12134/week @ 2022-10-26 12123/week @ 2022-11-02 12486/week @ 2022-11-09 11199/week @ 2022-11-16 6682/week @ 2022-11-23

44,783 downloads per month
Used in 43 crates (2 directly)

MIT/Apache

100KB
2K SLoC

neon

Cargo npm Linux Build Status macOS Build Status Windows Build Status

Rust bindings for writing safe and fast native Node.js modules.

Getting started

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!

Docs

See our Neon fundamentals docs and our API docs.

Neon 0.10 Migration Guide

The latest version of Neon, 0.10, includes a few small breaking changes in order to clean up and improve the usability of our APIs.

Read the new migration guide to learn how to port your Neon projects to 0.10!

Platform Support

Operating Systems

Linux macOS Windows

Node.js

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.

Bun (experimental)

Bun is an alternate JavaScript runtime that targets Node compatibility. In many cases Neon modules will work in bun; however, at the time of this writing, some Node-API functions are not implemented.

Rust

Neon supports Rust stable version 1.18 and higher. We test on the latest stable, beta, and nightly versions of Rust.

A Taste...

fn make_an_array(mut cx: FunctionContext) -> JsResult<JsArray> {
    // Create some values:
    let n = cx.number(9000);
    let s = cx.string("hello");
    let b = cx.boolean(true);

    // Create a new array:
    let array: Handle<JsArray> = cx.empty_array();

    // Push the values into the array:
    array.set(&mut cx, 0, n)?;
    array.set(&mut cx, 1, s)?;
    array.set(&mut cx, 2, b)?;

    // Return the array:
    Ok(array)
}

register_module!(mut cx, {
    cx.export_function("makeAnArray", make_an_array)
})

For more examples, see our examples repo.

Get Involved

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.

Testing Neon

The Neon project is both an NPM workspace and a Cargo workspace. The full suite of tests may be executed by installing and testing the NPM workspace.

npm install
npm test

Individual JavaScript packages may be tested with an npm workspace command:

npm --workspace=create-neon test

Individual Rust crates may be tested with a cargo workspace command:

cargo test -p neon-build

License

Licensed under either of

at your option.

Dependencies

~155KB