1. Home
  2. Browse
  3. node-api-headers

node-api-headers

v1.1.0#0Latest

Repository used to make the N-API headers more accessible

Install

Run the following Vcpkg command to install the port.

vcpkg install node-api-headers

Usage

node-api-headers provides CMake targets:

find_package(unofficial-node-api-headers CONFIG REQUIRED)
target_link_libraries(main PRIVATE unofficial::node-api-headers::node-api-headers)

Add this to your CMakeLists.txt to build a Node.js addon:

add_library(addon SHARED main.cpp ...)
set_target_properties(addon PROPERTIES OUTPUT_NAME "my-addon" PREFIX "" SUFFIX ".node")
find_package(unofficial-node-api-headers CONFIG REQUIRED)
target_link_libraries(addon PRIVATE unofficial::node-api-headers::node-api-headers)

You will be able to load your addon in JavaScript code:

const addon = require("/path/to/addon/my-addon.node");

Make sure that your Node.js OS/architecture matches vcpkg triplet you use.

Also, make sure to register a module in your C/C++ code like official example does:

https://github.com/nodejs/node-addon-examples/blob/main/1_hello_world/napi/hello.c

This port doesn't have specific functionality for publishing npm packages.

See https://nodejs.org/api/n-api.html

Dependencies

See source

Version

v1.1.0#0

Publication

Supports

(windows & !arm & !uwp) | linux | osx

GitHub

nodejs/node-api-headers33

Homepage

nodejs.org/api/addons.html

Subtree

a78464841a

License

MIT

Definition

Manifest