mhdawson1

nodejs-foundation

legendecas

jasongin

nicknaso

kevineady

gabrielschulhof

node-addon-api

    "url": "https://github.com/nodejs/node-addon-api/issues"

      "url": "https://github.com/abhi11210646"

      "url": "https://github.com/jmendeth"

      "url": "https://github.com/timarandras"

      "url": "https://github.com/kirbysayshi"

      "url": "https://github.com/anisha-rohra"

      "url": "https://github.com/addaleax"

      "url": "https://github.com/BotellaA"

      "url": "https://github.com/aruneshchandra"

      "url": "https://github.com/rivertam"

      "url": "https://github.com/gallafent"

      "url": "https://github.com/blagoev"

      "url": "https://github.com/bmacnaughton"

      "url": "https://github.com/corymickelson"

      "url": "https://github.com/RaisinTen"

      "url": "https://github.com/davedoesdev"

      "url": "https://github.com/deepakrkris"

      "url": "https://github.com/dmitryash"

      "url": "https://github.com/nadongguri"

      "url": "https://github.com/fholzer"

      "url": "https://github.com/ebickle"

      "url": "https://github.com/gabrielschulhof"

      "url": "https://github.com/devsnek"

      "url": "https://github.com/helio-frota"

      "url": "https://github.com/digitalinfinity"

      "url": "https://github.com/ikokostya"

      "url": "https://github.com/DuBistKomisch"

      "url": "https://github.com/yjaeseok"

      "url": "https://github.com/jasongin"

      "url": "https://github.com/jschlight"

      "url": "https://github.com/romandev"

      "url": "https://github.com/JoseExposito"

      "url": "https://github.com/joshgarde"

      "url": "https://github.com/hanazuki"

      "url": "https://github.com/kelvinhammond"

      "url": "https://github.com/KevinEady"

      "url": "https://github.com/kidneysolo"

      "url": "https://github.com/Nishikoh"

      "url": "https://github.com/strager"

      "url": "https://github.com/boingoing"

      "url": "https://github.com/fraxken"

      "url": "https://github.com/timrach"

      "url": "https://github.com/tniessen"

      "url": "https://github.com/todoroff"

      "url": "https://github.com/Velmisov"

      "url": "https://github.com/morokosi"

      "url": "https://github.com/fs-eire"

      "url": "https://github.com/ZzqiZQute"

  "description": "Node.js API (Node-API)",

  "homepage": "https://github.com/nodejs/node-addon-api",

    "url": "git://github.com/nodejs/node-addon-api.git"

    "prebenchmark": "node-gyp rebuild -C benchmark",

    "pretest": "node-gyp rebuild -C test",

    "predev": "node-gyp rebuild -C test --debug",

    "predev:incremental": "node-gyp configure build -C test --debug",

    "lint:fix": "node tools/clang-format --fix"

NOTE: The default branch has been renamed!

If you have a local clone, you can update it by running:

This module contains **header-only C++ wrapper classes** which simplify

the use of the C based [Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)

provided by Node.js when using C++. It provides a C++ object model

and exception handling semantics with low overhead.

There are three options for implementing addons: Node-API, nan, or direct

use of internal V8, libuv and Node.js libraries. Unless there is a need for

direct access to functionality which is not exposed by Node-API as outlined

in [C/C++ addons](https://nodejs.org/dist/latest/docs/api/addons.html)

[C/C++ addons with Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)

Node-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

The `node-addon-api` module, which is not part of Node.js, preserves the benefits

of the Node-API as it consists only of inline code that depends only on the stable API

provided by Node-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

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 Node-API and/or `node-addon-api`

exclusively and build against a version of Node.js that includes an

implementation of Node-API (meaning an active LTS version of Node.js) 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 Node-API ABI stability guarantee in particular.

As new APIs are added to Node-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 Node-API handles so

direct calls to Node-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**.

The [Node-API Resource](https://nodejs.github.io/node-addon-examples/) offers an

excellent orientation and tips for developers just getting started with Node-API

- **[More resource and info about native Addons](#resources)**

- **[Code of Conduct](CODE_OF_CONDUCT.md)**

(See [CHANGELOG.md](CHANGELOG.md) for complete Changelog)

[![NPM](https://nodei.co/npm/node-addon-api.png?downloads=true&downloadRank=true)](https://nodei.co/npm/node-addon-api/) [![NPM](https://nodei.co/npm-dl/node-addon-api.png?months=6&height=1)](https://nodei.co/npm/node-addon-api/)

node-addon-api is based on [Node-API](https://nodejs.org/api/n-api.html) and supports using different Node-API versions.

This allows addons built with it to run with Node.js versions which support the targeted Node-API version.

**However** the node-addon-api support model is to support only the active LTS Node.js versions. This means that

every year there will be a new major which drops support for the Node.js LTS version which has gone out of service.

The oldest Node.js version supported by the current version of node-addon-api is Node.js 12.x.

  - [Installation and usage](doc/setup.md)

  - [Conversion tool](doc/conversion-tool.md)

  - [Prebuild tools](doc/prebuild_tools.md)

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

 - [Full Class Hierarchy](doc/hierarchy.md)

    - [CallbackInfo](doc/callbackinfo.md)

            - [ObjectReference](doc/object_reference.md)

    - [PropertyDescriptor](doc/property_descriptor.md)

        - [FunctionReference](doc/function_reference.md)

        - [ClassPropertyDescriptor](doc/class_property_descriptor.md)

      - [TypedArrayOf](doc/typed_array_of.md)

 - [Error Handling](doc/error_handling.md)

 - [Object Lifetime Management](doc/object_lifetime_management.md)

    - [EscapableHandleScope](doc/escapable_handle_scope.md)

 - [Memory Management](doc/memory_management.md)

 - [Async Operations](doc/async_operations.md)

    - [AsyncContext](doc/async_context.md)

    - [AsyncWorker Variants](doc/async_worker_variants.md)

 - [Thread-safe Functions](doc/threadsafe.md)

    - [ThreadSafeFunction](doc/threadsafe_function.md)

    - [TypedThreadSafeFunction](doc/typed_threadsafe_function.md)

 - [Version management](doc/version_management.md)

Are you new to **node-addon-api**? Take a look at our **[examples](https://github.com/nodejs/node-addon-examples)**

- **[Hello World](https://github.com/nodejs/node-addon-examples/tree/HEAD/1_hello_world/node-addon-api)**

- **[Pass arguments to a function](https://github.com/nodejs/node-addon-examples/tree/HEAD/2_function_arguments/node-addon-api)**

- **[Callbacks](https://github.com/nodejs/node-addon-examples/tree/HEAD/3_callbacks/node-addon-api)**

- **[Object factory](https://github.com/nodejs/node-addon-examples/tree/HEAD/4_object_factory/node-addon-api)**

- **[Function factory](https://github.com/nodejs/node-addon-examples/tree/HEAD/5_function_factory/node-addon-api)**

- **[Wrapping C++ Object](https://github.com/nodejs/node-addon-examples/tree/HEAD/6_object_wrap/node-addon-api)**

- **[Factory of wrapped object](https://github.com/nodejs/node-addon-examples/tree/HEAD/7_factory_wrap/node-addon-api)**

- **[Passing wrapped object around](https://github.com/nodejs/node-addon-examples/tree/HEAD/8_passing_wrapped/node-addon-api)**

		@@ -79,2 +79,6 @@ {
		{
		"name": "Deepak Rajamohan",
		"url": "https://github.com/deepakrkris"
		},
		{
		"name": "Dmitry Ashkadov",
		@@ -280,2 +284,6 @@ "url": "https://github.com/dmitryash"
		{
		"name": "strager",
		"url": "https://github.com/strager"
		},
		{
		"name": "Taylor Woll",
		@@ -297,2 +305,6 @@ "url": "https://github.com/boingoing"
		{
		"name": "todoroff",
		"url": "https://github.com/todoroff"
		},
		{
		"name": "Tux3",
		@@ -324,2 +336,3 @@ "url": "https://github.com/tux3"
		"fs-extra": "^9.0.1",
		"path": "^0.12.7",
		"pre-commit": "^1.2.2",
		@@ -370,4 +383,4 @@ "safe-buffer": "^5.1.1"
		"pre-commit": "lint",
		"version": "4.1.0",
		"version": "4.2.0",
		"support": true
		}

		@@ -73,3 +73,3 @@ NOTE: The default branch has been renamed!

		## Current version: 4.1.0
		## Current version: 4.2.0

		@@ -76,0 +76,0 @@ (See [CHANGELOG.md](CHANGELOG.md) for complete Changelog)

Improved metrics

Worsened metrics