Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 1023 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (34 loc) · 1023 Bytes

Contributing

To install locally:

yarn install
yarn test

To rebuild the Node.JS addon:

yarn build

Node headers

To download headers for the current Node version:

yarn headers

These are downloaded to the include directory for inspection or for use by your IDE. node-addon-api also has a separate set of headers. If you're using Visual Studio Code then you can configure this by adding a file at .vscode/settings.json as follows:

{
  "C_Cpp.default.includePath": [
    "${workspaceFolder}/**",
    "${workspaceFolder}/node_modules/node-addon-api"
  ]
}

References