80ca75209a4bb981a8c0da251fdecb6725535f9a
[platform/upstream/nodejs.git] / deps / npm / man / man3 / npm-install.3
1 .\" Generated with Ronnjs 0.3.8
2 .\" http://github.com/kapouer/ronnjs/
3 .
4 .TH "NPM\-INSTALL" "3" "November 2013" "" ""
5 .
6 .SH "NAME"
7 \fBnpm-install\fR \-\- install a package programmatically
8 .
9 .SH "SYNOPSIS"
10 .
11 .nf
12 npm\.commands\.install([where,] packages, callback)
13 .
14 .fi
15 .
16 .SH "DESCRIPTION"
17 This acts much the same ways as installing on the command\-line\.
18 .
19 .P
20 The \'where\' parameter is optional and only used internally, and it specifies
21 where the packages should be installed to\.
22 .
23 .P
24 The \'packages\' parameter is an array of strings\. Each element in the array is
25 the name of a package to be installed\.
26 .
27 .P
28 Finally, \'callback\' is a function that will be called when all packages have been
29 installed or when an error has been encountered\.