From 4a7b7e8097fcd43bd1823050607270530d05541b Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 17 May 2017 17:16:37 -0400 Subject: [PATCH] doc: add reference to node_api.h in docs Realized that we don't actually point people to the file to include in order to access N-API functions. Add that. PR-URL: https://github.com/nodejs/node/pull/13084 Reviewed-By: Colin Ihrig Reviewed-By: Gibson Fahnestock Reviewed-By: Luigi Pinca Reviewed-By: Anna Henningsen --- doc/api/n-api.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 423e71859dea94..de841331aba0ad 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -52,6 +52,14 @@ for the N-API C based functions exported by Node.js. These wrappers are not part of N-API, nor will they be maintained as part of Node.js. One such example is: [node-api](https://github.com/nodejs/node-api). +In order to use the N-API functions, include the file +[node_api.h](https://github.com/nodejs/node/blob/master/src/node_api.h) +which is located in the src directory in the node development tree. +For example: +```C +#include +``` + ## Basic N-API Data Types N-API exposes the following fundamental datatypes as abstractions that are