The objective of these examples is to demonstrate how to build Node-API addons using CMake.js.
These example projects assume that CMake.js has been installed globally:
npm install -g cmake-js
cmake-js --help
Then, in each of the napi and node-addon-api directories, the following commands build and test each addon:
npm install
npm test
Complete CMake.js documentation can be found on the CMake.js GitHub repository.
When building Node-API addons, it's important to specify to the build system the Node-API version your code is designed to work with. With CMake.js, this information is specified in the CMakeLists.txt file:
add_definitions(-DNAPI_VERSION=3)
Since Node-API is ABI-stable, your Node-API addon will work, without recompilation, with the Node-API version you specify in NAPI_VERSION and all subsequent Node-API versions.
In the absence of a need for features available only in a specific Node-API version, version 3 is a good choice as it is the version of Node-API that was active when Node-API left experimental status.