Skip to content

Commit

Permalink
doc: add reference to node_api.h in docs
Browse files Browse the repository at this point in the history
Realized that we don't actually point people to the file to
include in order to access N-API functions.  Add that.

PR-URL: #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>
  • Loading branch information
mhdawson committed May 19, 2017
1 parent a63b245 commit 4a7b7e8
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4a7b7e8

Please sign in to comment.