Skip to content

doc: add reference to node_api.h in docs #13084

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mhdawson wants to merge 2 commits into from
Closed

doc: add reference to node_api.h in docs #13084

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d84863c
doc: add reference to node_api.h in docs
mhdawson May 17, 2017
767e35d
squash: address comments
mhdawson May 19, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,13 @@ 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" which
is located in the src directory in the node development tree. For example:
Copy link
Member

@gibfahn gibfahn May 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe worth including a link to the file in Github:

https://github.com/nodejs/node/blob/master/src/node_api.h

```C
#include <node_api.h>

Copy link
Member

@gibfahn gibfahn May 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra newline (can be fixed as part of landing).

```

## Basic N-API Data Types

N-API exposes the following fundamental datatypes as abstractions that are
Expand Down