Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/@npmcli/node-gyp/README.md')
-rw-r--r--node_modules/@npmcli/node-gyp/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/node_modules/@npmcli/node-gyp/README.md b/node_modules/@npmcli/node-gyp/README.md
new file mode 100644
index 000000000..a32fb2cb8
--- /dev/null
+++ b/node_modules/@npmcli/node-gyp/README.md
@@ -0,0 +1,16 @@
+# @npmcli/node-gyp
+
+This is the module npm uses to decide whether a package should be built
+using [`node-gyp`](https://github.com/nodejs/node-gyp) by default.
+
+## API
+
+* `isNodeGypPackage(path)`
+
+Returns a Promise that resolves to `true` or `false` based on whether the
+package at `path` has a `binding.gyp` file.
+
+* `defaultGypInstallScript`
+
+A string with the default string that should be used as the `install`
+script for node-gyp packages.