summaryrefslogtreecommitdiff
path: root/deps/npm/doc/api/install.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/doc/api/install.md')
-rw-r--r--deps/npm/doc/api/install.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/deps/npm/doc/api/install.md b/deps/npm/doc/api/install.md
new file mode 100644
index 0000000000..12f665a76c
--- /dev/null
+++ b/deps/npm/doc/api/install.md
@@ -0,0 +1,19 @@
+npm-install(3) -- install a package programmatically
+====================================================
+
+## SYNOPSIS
+
+ npm.commands.install([where,] packages, callback)
+
+## DESCRIPTION
+
+This acts much the same ways as installing on the command-line.
+
+The 'where' parameter is optional and only used internally, and it specifies
+where the packages should be installed to.
+
+The 'packages' parameter is an array of strings. Each element in the array is
+the name of a package to be installed.
+
+Finally, 'callback' is a function that will be called when all packages have been
+installed or when an error has been encountered.