Skip to content

doc: add ref to option to enable n-api #13406

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 ref to option to enable n-api #13406

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebdcb3f
doc: add ref to option to enable n-api
mhdawson Jun 2, 2017
da0c8ae
squash: address comments
mhdawson Jun 5, 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
Prev Previous commit
squash: address comments
  • Loading branch information
@mhdawson
mhdawson committed Jun 5, 2017
commit da0c8aeeef79b0ff1412d7dc289f70bafc7c9333
15 changes: 8 additions & 7 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,6 @@ changes in the underlying JavaScript engine and allow modules
compiled for one version to run on later versions of Node.js without
recompilation.

As the feature is currently experimental it must be enabled with the
following command line option:

```bash
--napi-modules
```

Addons are built/packaged with the same approach/tools
outlined in the section titled [C++ Addons](addons.html).
The only difference is the set of APIs that are used by the native code.
Expand Down Expand Up @@ -67,6 +60,14 @@ For example:
#include <node_api.h>
```

As the feature is experimental it must be enabled with the
following command line
[option](https://nodejs.org/dist/latest-v8.x/docs/api/cli.html#cli_napi_modules):

```bash
--napi-modules
```

## Basic N-API Data Types

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