Skip to content
Module for using N-API from C++
C++ JavaScript C Python
Branch: master
Clone or download
Pull request Compare This branch is 4 commits behind nodejs:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
external-napi
src
test
tools
.editorconfig
.gitignore
.npmignore
.npmrc
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE.md
README.md
appveyor.yml
index.js
napi-inl.deprecated.h
napi-inl.h
napi.h
package.json

README.md

node-addon-api module

This module contains header-only C++ wrapper classes which simplify the use of the C based N-API provided by Node.js when using C++. It provides a C++ object model and exception handling semantics with low overhead.

N-API is an ABI stable C interface provided by Node.js for building native addons. It is independent from the underlying JavaScript runtime (e.g. V8 or ChakraCore) and is maintained as part of Node.js itself. It is intended to insulate native 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.

The node-addon-api module, which is not part of Node.js, preserves the benefits of the N-API as it consists only of inline code that depends only on the stable API provided by N-API. As such, modules built against one version of Node.js using node-addon-api should run without having to be rebuilt with newer versions of Node.js.

It is important to remember that other Node.js interfaces such as libuv (included in a project via #include <uv.h>) are not ABI-stable across Node.js major versions. Thus, an addon must use N-API and/or node-addon-api exclusively and build against a version of Node.js that includes an implementation of N-API (meaning a version of Node.js newer than 6.14.2) in order to benefit from ABI stability across Node.js major versions. Node.js provides an ABI stability guide containing a detailed explanation of ABI stability in general, and the N-API ABI stability guarantee in particular.

As new APIs are added to N-API, node-addon-api must be updated to provide wrappers for those new APIs. For this reason node-addon-api provides methods that allow callers to obtain the underlying N-API handles so direct calls to N-API and the use of the objects/methods provided by node-addon-api can be used together. For example, in order to be able to use an API for which the node-addon-api does not yet provide a wrapper.

APIs exposed by node-addon-api are generally used to create and manipulate JavaScript values. Concepts and operations generally map to ideas specified in the ECMA262 Language Specification.

Current version: 1.7.1

(See CHANGELOG.md for complete Changelog)

NPM NPM

Setup

API Documentation

The following is the documentation for node-addon-api.

Examples

Are you new to node-addon-api? Take a look at our examples

Tests

To run the node-addon-api tests do:

npm install
npm test

To avoid testing the deprecated portions of the API run

npm install
npm test --disable-deprecated

Debug

To run the node-addon-api tests with --debug option:

npm run-script dev

If you want faster build, you might use the following option:

npm run-script dev:incremental

Take a look and get inspired by our test suite

Contributing

We love contributions from the community to node-addon-api. See CONTRIBUTING.md for more details on our philosophy around extending this module.

More resource and info about native Addons

WG Members / Collaborators

Active

Name GitHub Link
Anna Henningsen addaleax
Arunesh Chandra aruneshchandra
Gabriel Schulhof gabrielschulhof
Hitesh Kanwathirtha digitalinfinity
Jim Schlight jschlight
Michael Dawson mhdawson
Nicola Del Gobbo NickNaso
Taylor Woll boingoing

Emeritus

Name GitHub Link
Benjamin Byholm kkoopa
Jason Ginchereau jasongin
Sampson Gao sampsongao

Licensed under MIT

You can’t perform that action at this time.