Skip to content

Commit

Permalink
doc: add ref to option to enable n-api
Browse files Browse the repository at this point in the history
Since its guarded in by a command line option say
that in the docs and provide the option that needs
to be used to enable it.

Backport-PR-URL: #19447
PR-URL: #13406
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießn <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jason Ginchereau <jasongin@microsoft.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
  • Loading branch information
mhdawson authored and MylesBorins committed Apr 16, 2018
1 parent eb42279 commit 82f31ff
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/api/n-api.md
Expand Up @@ -60,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

0 comments on commit 82f31ff

Please sign in to comment.