Rust bindings for writing safe and fast native Node.js modules.
  • Rust 61.3%
  • TypeScript 16.1%
  • C++ 10.9%
  • JavaScript 6.2%
  • C 2.8%
  • Other 2.6%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
David Baker fe3bdfc949 Put node_gyp_output back
That line needs to stay for the root dir / lib file
2020-02-18 21:12:06 +00:00
cli Release 0.4.0 2020-02-14 16:31:51 -05:00
crates Put node_gyp_output back 2020-02-18 21:12:06 +00:00
dev v0.3.1 2019-08-22 18:12:24 -04:00
src Merge pull request #459 from kjvalencik/master 2020-02-14 15:59:21 -05:00
test Merge pull request #482 from goto-bus-stop/singleton-primitives 2020-02-14 15:58:04 -05:00
.gitignore ignore RLS logs 2018-06-15 12:14:59 -07:00
.travis.yml We didn't actually need the CI flag after all; just #[ignore] the static tests for all Rust versions except beta. 2019-09-30 13:23:39 -07:00
appveyor.yml Looks like the bug affects all currently supported Node versions so 2020-01-27 15:31:13 -08:00
AUTHORS.md Release 0.4.0 2020-02-14 16:31:51 -05:00
build.rs We didn't actually need the CI flag after all; just #[ignore] the static tests for all Rust versions except beta. 2019-09-30 13:23:39 -07:00
Cargo.toml Release 0.4.0 2020-02-14 16:31:51 -05:00
CODE_OF_CONDUCT.md Switching to the Contributor Covenant code of conduct. The Rust CoC is pretty good, but the CC CoC is a bit more polished and consistent, and also stated in a way that's less tied to one specific project. 2017-09-22 14:58:50 -07:00
CONTRIBUTING.md explain basics of contributing, including link to RFC process 2018-03-09 14:24:37 -08:00
LICENSE-APACHE Move neon-cli files into cli subdirectory, and restore temporarily-moved neon files back to project root. 2017-09-17 23:26:08 -07:00
LICENSE-MIT Relicensing! Like Neon itself, the neon CLI is now dual-licensed under 2017-09-02 05:26:06 -07:00
MIGRATION_GUIDE.md Review Comments 2019-12-23 16:09:49 -05:00
neon.png change image to png 2018-12-23 20:59:05 -08:00
README.md Update Node support matrix (drop 6, add 12). 2019-08-22 21:25:03 -07:00
RELEASES.md Release 0.4.0 2020-02-14 16:31:51 -05:00

neon

Travis Build Status Appveyor Build Status npm

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 install -g neon-cli
$ neon new 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.

Platform Support

Operating Systems

Linux macOS Windows
✓ ✓ ✓

Node.js

Node 8 Node 10 Node 12
✓ ✓ ✓

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.

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.

License

Licensed under either of

at your option.