hacking.md

% Hacking on Neon

This document provides some information about the internals of Neon, for people interested in contributing and who want to understand a little more about how Neon works under the hood.

Node

Node is the JavaScript runtime. It's built on V8.

Resources

• Node C/C++ Addons Docs
• Node ABI Table

V8

V8 is Chrome's JavaScript engine. It's written in C++.

Resources

• V8 Getting Started with Embedding
• V8 Embedder's Guide
• V8 API Docs by Node Version

NAN

NAN stands for Native Abstractions for Node.js. It normalizes changes in V8 and Node core so native addons compile against different versions of Node.js.

Resources

• NAN API Docs

neon-sys Crate

neon-sys is the glue that is exposing Node and V8 C++ APIs for use in Neon.

Resources

• neon-sys Crate Docs
• Cargo Build Script Support
  • -sys Packages

cslice Crate

cslice is a library of slices with a stable ABI for interfacing with C.

Resources

• cslice Crate Docs