https://github.com/nodejs/node-addon-api
Module for using Node-API from C++
https://github.com/nodejs/node-addon-api
node nodejs
Last synced: about 2 hours ago
JSON representation
Module for using Node-API from C++
- Host: GitHub
- URL: https://github.com/nodejs/node-addon-api
- Owner: nodejs
- License: mit
- Created: 2017-02-08T22:54:19.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T00:59:21.000Z (12 days ago)
- Last Synced: 2025-04-16T14:45:55.315Z (2 days ago)
- Topics: node, nodejs
- Language: C++
- Homepage:
- Size: 2.22 MB
- Stars: 2,250
- Watchers: 60
- Forks: 471
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-github-star - node-addon-api - API from C++ | nodejs | 1898 | (C++)
README
# **node-addon-api module**
[](https://app.codecov.io/gh/nodejs/node-addon-api/tree/main)
[](https://nodei.co/npm/node-addon-api/) [](https://nodei.co/npm/node-addon-api/)
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.
- [API References](doc/README.md)
- [Badges](#badges)
- [Contributing](#contributing)
- [License](#license)
## API References
API references are available in the [doc](doc/README.md) directory.
## Current version: 8.3.1
(See [CHANGELOG.md](CHANGELOG.md) for complete Changelog)
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 18.x.
## Badges
The use of badges is recommended to indicate the minimum version of Node-API
required for the module. This helps to determine which Node.js major versions are
supported. Addon maintainers can consult the [Node-API support matrix][] to determine
which Node.js versions provide a given Node-API version. The following badges are
available:
## Contributing
We love contributions from the community to **node-addon-api**!
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module.
## Team members
### Active
| Name | GitHub Link |
| ------------------- | ----------------------------------------------------- |
| Anna Henningsen | [addaleax](https://github.com/addaleax) |
| Chengzhong Wu | [legendecas](https://github.com/legendecas) |
| Jack Xia | [JckXia](https://github.com/JckXia) |
| Kevin Eady | [KevinEady](https://github.com/KevinEady) |
| Michael Dawson | [mhdawson](https://github.com/mhdawson) |
| Nicola Del Gobbo | [NickNaso](https://github.com/NickNaso) |
| Vladimir Morozov | [vmoroz](https://github.com/vmoroz) |
Emeritus
### Emeritus
| Name | GitHub Link |
| ------------------- | ----------------------------------------------------- |
| Arunesh Chandra | [aruneshchandra](https://github.com/aruneshchandra) |
| Benjamin Byholm | [kkoopa](https://github.com/kkoopa) |
| Gabriel Schulhof | [gabrielschulhof](https://github.com/gabrielschulhof) |
| Hitesh Kanwathirtha | [digitalinfinity](https://github.com/digitalinfinity) |
| Jason Ginchereau | [jasongin](https://github.com/jasongin) |
| Jim Schlight | [jschlight](https://github.com/jschlight) |
| Sampson Gao | [sampsongao](https://github.com/sampsongao) |
| Taylor Woll | [boingoing](https://github.com/boingoing) |
## License
Licensed under [MIT](./LICENSE.md)
[Node-API support matrix]: https://nodejs.org/dist/latest/docs/api/n-api.html#node-api-version-matrix