Skip to content
<open-source>
Oeiuwq Faith Blog OpenSource Porfolio

neon-bindings/neon

Rust bindings for writing safe and fast native Node.js modules.
Source code at GitHub https://www.neon-bindings.com/
neon-bindings/neon.json
{
  "createdAt": "2015-09-19T08:50:08Z",
  "defaultBranch": "main",
  "description": "Rust bindings for writing safe and fast native Node.js modules.",
  "fullName": "neon-bindings/neon",
  "homepage": "https://www.neon-bindings.com/",
  "language": "Rust",
  "name": "neon",
  "pushedAt": "2025-11-21T23:17:37Z",
  "stargazersCount": 8363,
  "topics": [],
  "updatedAt": "2025-11-26T01:42:51Z",
  "url": "https://github.com/neon-bindings/neon"
}

neon

Cargo Test Status Lint Status

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

Getting started

Section titled “Getting started”

Once you have the platform dependencies installed, getting started is as simple as:

$ npm init neon@latest my-project

Then see the Hello World guide for writing your first Hello World in Neon!

Docs

Section titled “Docs”

See our Neon fundamentals docs and our API docs.

Neon 1.0.0 Migration Guide

Section titled “Neon 1.0.0 Migration Guide”

The latest version of Neon, 1.0.0, includes several breaking changes in order to fix unsoundness, improve consistency, and add features.

Read the new [migration guide]!(doc/MIGRATION_GUIDE_1.0.0.md) to learn how to port your Neon projects to 1.0.0!

Platform Support

Section titled “Platform Support”

Operating Systems

Section titled “Operating Systems”
LinuxmacOSWindows
✓✓✓

Node.js

Section titled “Node.js”

Neon actively supports all current and maintenance releases of Node. If you’re using a different version of Node and believe it should be supported, let us know.

Older Node version support (minimum v10) may require lower Node-API versions. See the Node version support matrix for more details.

Bun (experimental)

Section titled “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

Section titled “Rust”

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

A Taste…

Section titled “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 = 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)
}


#[neon::main]
fn main(mut cx: ModuleContext) -> NeonResult<()> {
    cx.export_function("make_an_array", make_an_array)?;
    Ok(())
}

For more examples, see our examples repo and [integration tests]!(test).

Get Involved

Section titled “Get Involved”

The Neon community is just getting started and there’s tons of fun to be had. Come play! :)

The Neon Community Slack is open to all; use this invite link to receive an invitation.

Testing Neon

Section titled “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.

Terminal window
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

Section titled “License”

Licensed under either of

at your option.