Repository files navigation

This module containsheader-only C++ wrapper classes which simplifythe use of the C basedNode-APIprovided by Node.js when using C++. It provides a C++ object modeland exception handling semantics with low overhead.

• API References
• Badges
• Contributing
• License

API references are available in thedoc directory.

(SeeCHANGELOG.md for complete Changelog)

node-addon-api is based onNode-API 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 thatevery 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.

The use of badges is recommended to indicate the minimum version of Node-APIrequired for the module. This helps to determine which Node.js major versions aresupported. Addon maintainers can consult theNode-API support matrix to determinewhich Node.js versions provide a given Node-API version. The following badges areavailable:

We love contributions from the community tonode-addon-api!SeeCONTRIBUTING.md for more details on our philosophy around extending this module.

Licensed underMIT