Browse Source

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 <cjihrig@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
v6
Michael Dawson 8 years ago
committed by Michael Dawson
parent
commit
4a7b7e8097
  1. 8
      doc/api/n-api.md

8
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 <node_api.h>
```
## Basic N-API Data Types
N-API exposes the following fundamental datatypes as abstractions that are

Loading…
Cancel
Save