summaryrefslogtreecommitdiff
path: root/deps/npm/man/man3/npm-load.3
blob: dd92ce6846af8a002b3d5743ecd0735e0ca806ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
.TH "NPM\-LOAD" "3" "June 2015" "" ""
.SH "NAME"
\fBnpm-load\fR \- Load config settings
.SH SYNOPSIS
.P
.RS 2
.nf
npm\.load(conf, cb)
.fi
.RE
.SH DESCRIPTION
.P
npm\.load() must be called before any other function call\.  Both parameters are
optional, but the second is recommended\.
.P
The first parameter is an object containing command\-line config params, and the
second parameter is a callback that will be called when npm is loaded and ready
to serve\.
.P
The first parameter should follow a similar structure as the package\.json
config object\.
.P
For example, to emulate the \-\-dev flag, pass an object that looks like this:
.P
.RS 2
.nf
{
  "dev": true
}
.fi
.RE
.P
For a list of all the available command\-line configs, see \fBnpm help config\fR