diff options
Diffstat (limited to 'node_modules/node-addon-api/doc/checker-tool.md')
| -rw-r--r-- | node_modules/node-addon-api/doc/checker-tool.md | 32 |
1 files changed, 0 insertions, 32 deletions
diff --git a/node_modules/node-addon-api/doc/checker-tool.md b/node_modules/node-addon-api/doc/checker-tool.md deleted file mode 100644 index 499d3ab..0000000 --- a/node_modules/node-addon-api/doc/checker-tool.md +++ /dev/null @@ -1,32 +0,0 @@ -# Checker Tool - -**node-addon-api** provides a [checker tool][] that will inspect a given -directory tree, identifying all Node.js native addons therein, and further -indicating for each addon whether it is an N-API addon. - -## To use the checker tool: - - 1. Install the application with `npm install`. - - 2. If the application does not depend on **node-addon-api**, copy the - checker tool into the application's directory. - - 3. If the application does not depend on **node-addon-api**, run the checker - tool from the application's directory: - - ```sh - node ./check-napi.js - ``` - - Otherwise, the checker tool can be run from the application's - `node_modules/` subdirectory: - - ```sh - node ./node_modules/node-addon-api/tools/check-napi.js - ``` - -The tool accepts the root directory from which to start checking for Node.js -native addons as a single optional command line parameter. If ommitted it will -start checking from the current directory (`.`). - -[checker tool]: ../tools/check-napi.js |