From 82f31ff4af4c7ec9d4d661c30aa9a1514918e0d2 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Fri, 2 Jun 2017 12:01:32 -0400 Subject: [PATCH] doc: add ref to option to enable n-api MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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: https://github.com/nodejs/node/pull/19447 PR-URL: https://github.com/nodejs/node/pull/13406 Reviewed-By: Colin Ihrig Reviewed-By: Tobias Nießn Reviewed-By: James M Snell Reviewed-By: Jason Ginchereau Reviewed-By: Gibson Fahnestock --- doc/api/n-api.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index ab90cf05f4750d..3f5f9f4d9d2e03 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -60,6 +60,14 @@ For example: #include ``` +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