Repository files navigation

• Introduction
• Contributing
• Code of Conduct
• Install
• API
• Creating a release
• Team
• License

node-api-headers contains the header files for the C-based Node-APIprovided by Node.js. Node-API is an API for building native addons thatguarantees the ABI (Application Binary Interface) stability across versionsof Node.js (see:Node-API).

Node-API headers are in theinclude folder. The Node-APIs that provideECMAScript features from native code can be found injs_native_api_types.handjs_native_api.h. The APIs defined in these headers are included innode_api_types.h andnode_api.h.The headers are structured in this way in order to allow implementations ofNode-API outside of Node.js considering that for those implementations theNode.js specific APIs may not be applicable.

node-api-headers is also a package published onnpm that could be usedin a process to compile and build native addons for Node.js.

npm i node-api-headers

Node-API C headers are backward-compatible. Its version (e.g.8) is releasedseparately from the Node.js version stream (e.g.19.8.1) and changes arebackported to active Node.js LTS lines (e.g.16.x and18.x).

This package publishes semver-minor versions with new Node-API C headers changes.JS API breaking changes are published with new semver-major versions.

The module exports two propertiesinclude_dir andsymbols.

This property is a string that represents the include path for the Node-APIheaders.

This property is an object that has two keysjs_native_api_def andnode_api_def which represents the path of the module definition file for thejs_native_api andnode_api respectively.

This property is an object that represents the symbols exported by Node-APIgrouped by version and api types.

V1:{js_native_api_symbols:[// List of symbols in js_native_api.h for the version 1.],node_api_symbols:[// List of symbols in node_api.h for the version 1]},// ...

The project is maintained by theNode-API team members.

Licensed underMIT