Skip to content
Browse files

doc: Add initial documentation for N-API

Add the initial documentation for the N-API

This PR is a result of work in the abi-stable-node repo:,
with this PR being the cumulative work on the documentation
sections in that repo with the following contributors
in alphabetical order:

Author: Arunesh Chandra <>
Author: Gabriel Schulhof <>
Author: Hitesh Kanwathirtha <>
Author: Jason Ginchereau <>
Author: Michael Dawson <>
Author: Sampson Gao <>
Author: Taylor Woll <>

PR-URL: #12549
Reviewed-By: James M Snell <>
Reviewed-By: Jeremiah Senkpiel <>
Reviewed-By: Colin Ihrig <>
  • Loading branch information...
mhdawson committed Apr 19, 2017
1 parent 9d4bb55 commit deb9622b11a2780f35e5d122273abcf6458bbe4b
Showing with 3,019 additions and 0 deletions.
  1. +1 −0 doc/api/
  2. +20 −0 doc/api/
  3. +2,998 −0 doc/api/
@@ -8,6 +8,7 @@
* [Assertion Testing](assert.html)
* [Buffer](buffer.html)
* [C/C++ Addons](addons.html)
* [C/C++ Addons - N-API](n-api.html)
* [Child Processes](child_process.html)
* [Cluster](cluster.html)
* [Command Line Options](cli.html)
@@ -213,6 +213,26 @@ Addon developers are recommended to use to keep compatibility between past and
future releases of V8 and Node.js. See the `nan` [examples][] for an
illustration of how it can be used.

## N-API

> Stability: 1 - Experimental
N-API is an API for building native Addons. It is independent from
the underlying JavaScript runtime (ex V8) and is maintained as part of
Node.js itself. This API will be Application Binary Interface (ABI) stable
across version of Node.js. It is intended to insulate Addons from
changes in the underlying JavaScript engine and allow modules
compiled for one version to run on later versions of Node.js without
recompilation. Addons are built/packaged with the same approach/tools
outlined in this document (node-gyp, etc.). The only difference is the
set of APIs that are used by the native code. Instead of using the V8
or [Native Abstractions for Node.js][] APIs, the functions available
in the N-API are used.

The functions available and how to use them are documented in the
section titled [C/C++ Addons - N-API](n-api.html).

## Addon examples

Following are some example Addons intended to help developers get started. The

0 comments on commit deb9622

Please sign in to comment.
You can’t perform that action at this time.