mirror of
https://github.com/S2-/minifyfromhtml.git
synced 2025-08-03 20:30:04 +02:00
update packages to latest version
This commit is contained in:
17
node_modules/npm/man/man3/npm-bin.3
generated
vendored
Normal file
17
node_modules/npm/man/man3/npm-bin.3
generated
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
.TH "NPM\-BIN" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-bin\fR \- Display npm bin folder
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.bin(args, cb)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
Print the folder where npm will install executables\.
|
||||
.P
|
||||
This function should not be used programmatically\. Instead, just refer
|
||||
to the \fBnpm\.bin\fP property\.
|
||||
|
23
node_modules/npm/man/man3/npm-bugs.3
generated
vendored
Normal file
23
node_modules/npm/man/man3/npm-bugs.3
generated
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
.TH "NPM\-BUGS" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-bugs\fR \- Bugs for a package in a web browser maybe
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.bugs(package, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This command tries to guess at the likely location of a package's
|
||||
bug tracker URL, and then tries to open it using the \fB\-\-browser\fP
|
||||
config param\.
|
||||
.P
|
||||
Like other commands, the first parameter is an array\. This command only
|
||||
uses the first element, which is expected to be a package name with an
|
||||
optional version number\.
|
||||
.P
|
||||
This command will launch a browser, so this command may not be the most
|
||||
friendly for programmatic use\.
|
||||
|
34
node_modules/npm/man/man3/npm-cache.3
generated
vendored
Normal file
34
node_modules/npm/man/man3/npm-cache.3
generated
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
.TH "NPM\-CACHE" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-cache\fR \- manage the npm cache programmatically
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.cache([args], callback)
|
||||
|
||||
// helpers
|
||||
npm\.commands\.cache\.clean([args], callback)
|
||||
npm\.commands\.cache\.add([args], callback)
|
||||
npm\.commands\.cache\.read(name, version, forceBypass, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This acts much the same ways as the npm help cache command line
|
||||
functionality\.
|
||||
.P
|
||||
The callback is called with the package\.json data of the thing that is
|
||||
eventually added to or read from the cache\.
|
||||
.P
|
||||
The top level \fBnpm\.commands\.cache(\.\.\.)\fP functionality is a public
|
||||
interface, and like all commands on the \fBnpm\.commands\fP object, it will
|
||||
match the command line behavior exactly\.
|
||||
.P
|
||||
However, the cache folder structure and the cache helper functions are
|
||||
considered \fBinternal\fR API surface, and as such, may change in future
|
||||
releases of npm, potentially without warning or significant version
|
||||
incrementation\.
|
||||
.P
|
||||
Use at your own risk\.
|
||||
|
28
node_modules/npm/man/man3/npm-commands.3
generated
vendored
Normal file
28
node_modules/npm/man/man3/npm-commands.3
generated
vendored
Normal file
@@ -0,0 +1,28 @@
|
||||
.TH "NPM\-COMMANDS" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-commands\fR \- npm commands
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands[<command>](args, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
npm comes with a full set of commands, and each of the commands takes a
|
||||
similar set of arguments\.
|
||||
.P
|
||||
In general, all commands on the command object take an \fBarray\fR of positional
|
||||
argument \fBstrings\fR\|\. The last argument to any function is a callback\. Some
|
||||
commands are special and take other optional arguments\.
|
||||
.P
|
||||
All commands have their own man page\. See \fBman npm\-<command>\fP for command\-line
|
||||
usage, or \fBman 3 npm\-<command>\fP for programmatic usage\.
|
||||
.SH SEE ALSO
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
npm help 7 index
|
||||
|
||||
.RE
|
||||
|
49
node_modules/npm/man/man3/npm-config.3
generated
vendored
Normal file
49
node_modules/npm/man/man3/npm-config.3
generated
vendored
Normal file
@@ -0,0 +1,49 @@
|
||||
.TH "NPM\-CONFIG" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-config\fR \- Manage the npm configuration files
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.config(args, callback)
|
||||
var val = npm\.config\.get(key)
|
||||
npm\.config\.set(key, val)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This function acts much the same way as the command\-line version\. The first
|
||||
element in the array tells config what to do\. Possible values are:
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
\fBset\fP
|
||||
Sets a config parameter\. The second element in \fBargs\fP is interpreted as the
|
||||
key, and the third element is interpreted as the value\.
|
||||
.IP \(bu 2
|
||||
\fBget\fP
|
||||
Gets the value of a config parameter\. The second element in \fBargs\fP is the
|
||||
key to get the value of\.
|
||||
.IP \(bu 2
|
||||
\fBdelete\fP (\fBrm\fP or \fBdel\fP)
|
||||
Deletes a parameter from the config\. The second element in \fBargs\fP is the
|
||||
key to delete\.
|
||||
.IP \(bu 2
|
||||
\fBlist\fP (\fBls\fP)
|
||||
Show all configs that aren't secret\. No parameters necessary\.
|
||||
.IP \(bu 2
|
||||
\fBedit\fP:
|
||||
Opens the config file in the default editor\. This command isn't very useful
|
||||
programmatically, but it is made available\.
|
||||
|
||||
.RE
|
||||
.P
|
||||
To programmatically access npm configuration settings, or set them for
|
||||
the duration of a program, use the \fBnpm\.config\.set\fP and \fBnpm\.config\.get\fP
|
||||
functions instead\.
|
||||
.SH SEE ALSO
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
npm apihelp npm
|
||||
|
||||
.RE
|
||||
|
43
node_modules/npm/man/man3/npm-deprecate.3
generated
vendored
Normal file
43
node_modules/npm/man/man3/npm-deprecate.3
generated
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
.TH "NPM\-DEPRECATE" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-deprecate\fR \- Deprecate a version of a package
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.deprecate(args, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This command will update the npm registry entry for a package, providing
|
||||
a deprecation warning to all who attempt to install it\.
|
||||
.P
|
||||
The 'args' parameter must have exactly two elements:
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
\fBpackage[@version]\fP
|
||||
The \fBversion\fP portion is optional, and may be either a range, or a
|
||||
specific version, or a tag\.
|
||||
.IP \(bu 2
|
||||
\fBmessage\fP
|
||||
The warning message that will be printed whenever a user attempts to
|
||||
install the package\.
|
||||
|
||||
.RE
|
||||
.P
|
||||
Note that you must be the package owner to deprecate something\. See the
|
||||
\fBowner\fP and \fBadduser\fP help topics\.
|
||||
.P
|
||||
To un\-deprecate a package, specify an empty string (\fB""\fP) for the \fBmessage\fP argument\.
|
||||
.SH SEE ALSO
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
npm apihelp publish
|
||||
.IP \(bu 2
|
||||
npm apihelp unpublish
|
||||
.IP \(bu 2
|
||||
npm help 7 registry
|
||||
|
||||
.RE
|
||||
|
23
node_modules/npm/man/man3/npm-docs.3
generated
vendored
Normal file
23
node_modules/npm/man/man3/npm-docs.3
generated
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
.TH "NPM\-DOCS" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-docs\fR \- Docs for a package in a web browser maybe
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.docs(package, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This command tries to guess at the likely location of a package's
|
||||
documentation URL, and then tries to open it using the \fB\-\-browser\fP
|
||||
config param\.
|
||||
.P
|
||||
Like other commands, the first parameter is an array\. This command only
|
||||
uses the first element, which is expected to be a package name with an
|
||||
optional version number\.
|
||||
.P
|
||||
This command will launch a browser, so this command may not be the most
|
||||
friendly for programmatic use\.
|
||||
|
28
node_modules/npm/man/man3/npm-edit.3
generated
vendored
Normal file
28
node_modules/npm/man/man3/npm-edit.3
generated
vendored
Normal file
@@ -0,0 +1,28 @@
|
||||
.TH "NPM\-EDIT" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-edit\fR \- Edit an installed package
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.edit(package, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
Opens the package folder in the default editor (or whatever you've
|
||||
configured as the npm \fBeditor\fP config \-\- see \fBnpm help config\fP\|\.)
|
||||
.P
|
||||
After it has been edited, the package is rebuilt so as to pick up any
|
||||
changes in compiled packages\.
|
||||
.P
|
||||
For instance, you can do \fBnpm install connect\fP to install connect
|
||||
into your package, and then \fBnpm\.commands\.edit(["connect"], callback)\fP
|
||||
to make a few changes to your locally installed copy\.
|
||||
.P
|
||||
The first parameter is a string array with a single element, the package
|
||||
to open\. The package can optionally have a version number attached\.
|
||||
.P
|
||||
Since this command opens an editor in a new process, be careful about where
|
||||
and how this is used\.
|
||||
|
22
node_modules/npm/man/man3/npm-explore.3
generated
vendored
Normal file
22
node_modules/npm/man/man3/npm-explore.3
generated
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
.TH "NPM\-EXPLORE" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-explore\fR \- Browse an installed package
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.explore(args, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
Spawn a subshell in the directory of the installed package specified\.
|
||||
.P
|
||||
If a command is specified, then it is run in the subshell, which then
|
||||
immediately terminates\.
|
||||
.P
|
||||
Note that the package is \fInot\fR automatically rebuilt afterwards, so be
|
||||
sure to use \fBnpm rebuild <pkg>\fP if you make any changes\.
|
||||
.P
|
||||
The first element in the 'args' parameter must be a package name\. After that is the optional command, which can be any number of strings\. All of the strings will be combined into one, space\-delimited command\.
|
||||
|
41
node_modules/npm/man/man3/npm-help-search.3
generated
vendored
Normal file
41
node_modules/npm/man/man3/npm-help-search.3
generated
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
.TH "NPM\-HELP\-SEARCH" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-help-search\fR \- Search the help pages
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.helpSearch(args, [silent,] callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This command is rarely useful, but it exists in the rare case that it is\.
|
||||
.P
|
||||
This command takes an array of search terms and returns the help pages that
|
||||
match in order of best match\.
|
||||
.P
|
||||
If there is only one match, then npm displays that help section\. If there
|
||||
are multiple results, the results are printed to the screen formatted and the
|
||||
array of results is returned\. Each result is an object with these properties:
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
hits:
|
||||
A map of args to number of hits on that arg\. For example, {"npm": 3}
|
||||
.IP \(bu 2
|
||||
found:
|
||||
Total number of unique args that matched\.
|
||||
.IP \(bu 2
|
||||
totalHits:
|
||||
Total number of hits\.
|
||||
.IP \(bu 2
|
||||
lines:
|
||||
An array of all matching lines (and some adjacent lines)\.
|
||||
.IP \(bu 2
|
||||
file:
|
||||
Name of the file that matched
|
||||
|
||||
.RE
|
||||
.P
|
||||
The silent parameter is not necessary not used, but it may in the future\.
|
||||
|
32
node_modules/npm/man/man3/npm-init.3
generated
vendored
Normal file
32
node_modules/npm/man/man3/npm-init.3
generated
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
.TH "NPM" "" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm\fR
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.init(args, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This will ask you a bunch of questions, and then write a package\.json for you\.
|
||||
.P
|
||||
It attempts to make reasonable guesses about what you want things to be set to,
|
||||
and then writes a package\.json file with the options you've selected\.
|
||||
.P
|
||||
If you already have a package\.json file, it'll read that first, and default to
|
||||
the options in there\.
|
||||
.P
|
||||
It is strictly additive, so it does not delete options from your package\.json
|
||||
without a really good reason to do so\.
|
||||
.P
|
||||
Since this function expects to be run on the command\-line, it doesn't work very
|
||||
well as a programmatically\. The best option is to roll your own, and since
|
||||
JavaScript makes it stupid simple to output formatted JSON, that is the
|
||||
preferred method\. If you're sure you want to handle command\-line prompting,
|
||||
then go ahead and use this programmatically\.
|
||||
.SH SEE ALSO
|
||||
.P
|
||||
npm help 5 package\.json
|
||||
|
23
node_modules/npm/man/man3/npm-install.3
generated
vendored
Normal file
23
node_modules/npm/man/man3/npm-install.3
generated
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
.TH "NPM\-INSTALL" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-install\fR \- install a package programmatically
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.install([where,] packages, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This acts much the same ways as installing on the command\-line\.
|
||||
.P
|
||||
The 'where' parameter is optional and only used internally, and it specifies
|
||||
where the packages should be installed to\.
|
||||
.P
|
||||
The 'packages' parameter is an array of strings\. Each element in the array is
|
||||
the name of a package to be installed\.
|
||||
.P
|
||||
Finally, 'callback' is a function that will be called when all packages have been
|
||||
installed or when an error has been encountered\.
|
||||
|
41
node_modules/npm/man/man3/npm-link.3
generated
vendored
Normal file
41
node_modules/npm/man/man3/npm-link.3
generated
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
.TH "NPM\-LINK" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-link\fR \- Symlink a package folder
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.link(callback)
|
||||
npm\.commands\.link(packages, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
Package linking is a two\-step process\.
|
||||
.P
|
||||
Without parameters, link will create a globally\-installed
|
||||
symbolic link from \fBprefix/package\-name\fP to the current folder\.
|
||||
.P
|
||||
With a parameters, link will create a symlink from the local \fBnode_modules\fP
|
||||
folder to the global symlink\.
|
||||
.P
|
||||
When creating tarballs for \fBnpm publish\fP, the linked packages are
|
||||
"snapshotted" to their current state by resolving the symbolic links\.
|
||||
.P
|
||||
This is
|
||||
handy for installing your own stuff, so that you can work on it and test it
|
||||
iteratively without having to continually rebuild\.
|
||||
.P
|
||||
For example:
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.link(cb) # creates global link from the cwd
|
||||
# (say redis package)
|
||||
npm\.commands\.link('redis', cb) # link\-install the package
|
||||
.fi
|
||||
.RE
|
||||
.P
|
||||
Now, any changes to the redis package will be reflected in
|
||||
the package in the current working directory
|
||||
|
34
node_modules/npm/man/man3/npm-load.3
generated
vendored
Normal file
34
node_modules/npm/man/man3/npm-load.3
generated
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
.TH "NPM\-LOAD" "3" "March 2017" "" ""
|
||||
.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\fP
|
||||
|
68
node_modules/npm/man/man3/npm-ls.3
generated
vendored
Normal file
68
node_modules/npm/man/man3/npm-ls.3
generated
vendored
Normal file
@@ -0,0 +1,68 @@
|
||||
.TH "NPM\-LS" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-ls\fR \- List installed packages
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.ls(args, [silent,] callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This command will print to stdout all the versions of packages that are
|
||||
installed, as well as their dependencies, in a tree\-structure\. It will also
|
||||
return that data using the callback\.
|
||||
.P
|
||||
This command does not take any arguments, but args must be defined\.
|
||||
Beyond that, if any arguments are passed in, npm will politely warn that it
|
||||
does not take positional arguments, though you may set config flags
|
||||
like with any other command, such as \fBglobal\fP to list global packages\.
|
||||
.P
|
||||
It will print out extraneous, missing, and invalid packages\.
|
||||
.P
|
||||
If the silent parameter is set to true, nothing will be output to the screen,
|
||||
but the data will still be returned\.
|
||||
.P
|
||||
Callback is provided an error if one occurred, the full data about which
|
||||
packages are installed and which dependencies they will receive, and a
|
||||
"lite" data object which just shows which versions are installed where\.
|
||||
Note that the full data object is a circular structure, so care must be
|
||||
taken if it is serialized to JSON\.
|
||||
.SH CONFIGURATION
|
||||
.SS long
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
Default: false
|
||||
.IP \(bu 2
|
||||
Type: Boolean
|
||||
|
||||
.RE
|
||||
.P
|
||||
Show extended information\.
|
||||
.SS parseable
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
Default: false
|
||||
.IP \(bu 2
|
||||
Type: Boolean
|
||||
|
||||
.RE
|
||||
.P
|
||||
Show parseable output instead of tree view\.
|
||||
.SS global
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
Default: false
|
||||
.IP \(bu 2
|
||||
Type: Boolean
|
||||
|
||||
.RE
|
||||
.P
|
||||
List packages in the global install prefix instead of in the current
|
||||
project\.
|
||||
.P
|
||||
Note, if parseable is set or long isn't set, then duplicates will be trimmed\.
|
||||
This means that if a submodule has the same dependency as a parent module, then the
|
||||
dependency will only be output once\.
|
||||
|
17
node_modules/npm/man/man3/npm-outdated.3
generated
vendored
Normal file
17
node_modules/npm/man/man3/npm-outdated.3
generated
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
.TH "NPM\-OUTDATED" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-outdated\fR \- Check for outdated packages
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.outdated([packages,] callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This command will check the registry to see if the specified packages are
|
||||
currently outdated\.
|
||||
.P
|
||||
If the 'packages' parameter is left out, npm will check all packages\.
|
||||
|
43
node_modules/npm/man/man3/npm-owner.3
generated
vendored
Normal file
43
node_modules/npm/man/man3/npm-owner.3
generated
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
.TH "NPM\-OWNER" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-owner\fR \- Manage package owners
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.owner(args, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
The first element of the 'args' parameter defines what to do, and the subsequent
|
||||
elements depend on the action\. Possible values for the action are (order of
|
||||
parameters are given in parenthesis):
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
ls (package):
|
||||
List all the users who have access to modify a package and push new versions\.
|
||||
Handy when you need to know who to bug for help\.
|
||||
.IP \(bu 2
|
||||
add (user, package):
|
||||
Add a new user as a maintainer of a package\. This user is enabled to modify
|
||||
metadata, publish new versions, and add other owners\.
|
||||
.IP \(bu 2
|
||||
rm (user, package):
|
||||
Remove a user from the package owner list\. This immediately revokes their
|
||||
privileges\.
|
||||
|
||||
.RE
|
||||
.P
|
||||
Note that there is only one level of access\. Either you can modify a package,
|
||||
or you can't\. Future versions may contain more fine\-grained access levels, but
|
||||
that is not implemented at this time\.
|
||||
.SH SEE ALSO
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
npm apihelp publish
|
||||
.IP \(bu 2
|
||||
npm help 7 registry
|
||||
|
||||
.RE
|
||||
|
23
node_modules/npm/man/man3/npm-pack.3
generated
vendored
Normal file
23
node_modules/npm/man/man3/npm-pack.3
generated
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
.TH "NPM\-PACK" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-pack\fR \- Create a tarball from a package
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.pack([packages,] callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
For anything that's installable (that is, a package folder, tarball,
|
||||
tarball url, name@tag, name@version, or name), this command will fetch
|
||||
it to the cache, and then copy the tarball to the current working
|
||||
directory as \fB<name>\-<version>\.tgz\fP, and then write the filenames out to
|
||||
stdout\.
|
||||
.P
|
||||
If the same package is specified multiple times, then the file will be
|
||||
overwritten the second time\.
|
||||
.P
|
||||
If no arguments are supplied, then npm packs the current package folder\.
|
||||
|
18
node_modules/npm/man/man3/npm-ping.3
generated
vendored
Normal file
18
node_modules/npm/man/man3/npm-ping.3
generated
vendored
Normal file
@@ -0,0 +1,18 @@
|
||||
.TH "NPM\-PING" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-ping\fR \- Ping npm registry
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.registry\.ping(registry, options, function (er, pong))
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
Attempts to connect to the given registry, returning a \fBpong\fP
|
||||
object with various metadata if it succeeds\.
|
||||
.P
|
||||
This function is primarily useful for debugging connection issues
|
||||
to npm registries\.
|
||||
|
19
node_modules/npm/man/man3/npm-prefix.3
generated
vendored
Normal file
19
node_modules/npm/man/man3/npm-prefix.3
generated
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
.TH "NPM\-PREFIX" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-prefix\fR \- Display prefix
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.prefix(args, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
Print the prefix to standard out\.
|
||||
.P
|
||||
\|'args' is never used and callback is never called with data\.
|
||||
\|'args' must be present or things will break\.
|
||||
.P
|
||||
This function is not useful programmatically
|
||||
|
21
node_modules/npm/man/man3/npm-prune.3
generated
vendored
Normal file
21
node_modules/npm/man/man3/npm-prune.3
generated
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
.TH "NPM\-PRUNE" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-prune\fR \- Remove extraneous packages
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.prune([packages,] callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This command removes "extraneous" packages\.
|
||||
.P
|
||||
The first parameter is optional, and it specifies packages to be removed\.
|
||||
.P
|
||||
No packages are specified, then all packages will be checked\.
|
||||
.P
|
||||
Extraneous packages are packages that are not listed on the parent
|
||||
package's dependencies list\.
|
||||
|
41
node_modules/npm/man/man3/npm-publish.3
generated
vendored
Normal file
41
node_modules/npm/man/man3/npm-publish.3
generated
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
.TH "NPM\-PUBLISH" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-publish\fR \- Publish a package
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.publish([packages,] callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
Publishes a package to the registry so that it can be installed by name\.
|
||||
Possible values in the 'packages' array are:
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
\fB<folder>\fP:
|
||||
A folder containing a package\.json file
|
||||
.IP \(bu 2
|
||||
\fB<tarball>\fP:
|
||||
A url or file path to a gzipped tar archive containing a single folder
|
||||
with a package\.json file inside\.
|
||||
|
||||
.RE
|
||||
.P
|
||||
If the package array is empty, npm will try to publish something in the
|
||||
current working directory\.
|
||||
.P
|
||||
This command could fails if one of the packages specified already exists in
|
||||
the registry\. Overwrites when the "force" environment variable is set\.
|
||||
.SH SEE ALSO
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
npm help 7 registry
|
||||
.IP \(bu 2
|
||||
npm help adduser
|
||||
.IP \(bu 2
|
||||
npm apihelp owner
|
||||
|
||||
.RE
|
||||
|
19
node_modules/npm/man/man3/npm-rebuild.3
generated
vendored
Normal file
19
node_modules/npm/man/man3/npm-rebuild.3
generated
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
.TH "NPM\-REBUILD" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-rebuild\fR \- Rebuild a package
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.rebuild([packages,] callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This command runs the \fBnpm build\fP command on each of the matched packages\. This is useful
|
||||
when you install a new version of node, and must recompile all your C++ addons with
|
||||
the new binary\. If no 'packages' parameter is specify, every package will be rebuilt\.
|
||||
.SH CONFIGURATION
|
||||
.P
|
||||
See \fBnpm help build\fP
|
||||
|
23
node_modules/npm/man/man3/npm-repo.3
generated
vendored
Normal file
23
node_modules/npm/man/man3/npm-repo.3
generated
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
.TH "NPM\-REPO" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-repo\fR \- Open package repository page in the browser
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.repo(package, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This command tries to guess at the likely location of a package's
|
||||
repository URL, and then tries to open it using the \fB\-\-browser\fP
|
||||
config param\.
|
||||
.P
|
||||
Like other commands, the first parameter is an array\. This command only
|
||||
uses the first element, which is expected to be a package name with an
|
||||
optional version number\.
|
||||
.P
|
||||
This command will launch a browser, so this command may not be the most
|
||||
friendly for programmatic use\.
|
||||
|
58
node_modules/npm/man/man3/npm-restart.3
generated
vendored
Normal file
58
node_modules/npm/man/man3/npm-restart.3
generated
vendored
Normal file
@@ -0,0 +1,58 @@
|
||||
.TH "NPM\-RESTART" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-restart\fR \- Restart a package
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.restart(packages, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This restarts a package (or multiple packages)\.
|
||||
.P
|
||||
This runs a package's "stop", "restart", and "start" scripts, and associated
|
||||
pre\- and post\- scripts, in the order given below:
|
||||
.RS 0
|
||||
.IP 1. 3
|
||||
prerestart
|
||||
.IP 2. 3
|
||||
prestop
|
||||
.IP 3. 3
|
||||
stop
|
||||
.IP 4. 3
|
||||
poststop
|
||||
.IP 5. 3
|
||||
restart
|
||||
.IP 6. 3
|
||||
prestart
|
||||
.IP 7. 3
|
||||
start
|
||||
.IP 8. 3
|
||||
poststart
|
||||
.IP 9. 3
|
||||
postrestart
|
||||
|
||||
.RE
|
||||
.P
|
||||
If no version is specified, then it restarts the "active" version\.
|
||||
.P
|
||||
npm can restart multiple packages\. Just specify multiple packages in
|
||||
the \fBpackages\fP parameter\.
|
||||
.SH NOTE
|
||||
.P
|
||||
Note that the "restart" script is run \fBin addition to\fR the "stop"
|
||||
and "start" scripts, not instead of them\.
|
||||
.P
|
||||
This is the behavior as of \fBnpm\fP major version 2\. A change in this
|
||||
behavior will be accompanied by an increase in major version number
|
||||
.SH SEE ALSO
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
npm apihelp start
|
||||
.IP \(bu 2
|
||||
npm apihelp stop
|
||||
|
||||
.RE
|
||||
|
19
node_modules/npm/man/man3/npm-root.3
generated
vendored
Normal file
19
node_modules/npm/man/man3/npm-root.3
generated
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
.TH "NPM\-ROOT" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-root\fR \- Display npm root
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.root(args, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
Print the effective \fBnode_modules\fP folder to standard out\.
|
||||
.P
|
||||
\|'args' is never used and callback is never called with data\.
|
||||
\|'args' must be present or things will break\.
|
||||
.P
|
||||
This function is not useful programmatically\.
|
||||
|
37
node_modules/npm/man/man3/npm-run-script.3
generated
vendored
Normal file
37
node_modules/npm/man/man3/npm-run-script.3
generated
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
.TH "NPM\-RUN\-SCRIPT" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-run-script\fR \- Run arbitrary package scripts
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.run\-script(args, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This runs an arbitrary command from a package's "scripts" object\.
|
||||
.P
|
||||
It is used by the test, start, restart, and stop commands, but can be
|
||||
called directly, as well\.
|
||||
.P
|
||||
The 'args' parameter is an array of strings\. Behavior depends on the number
|
||||
of elements\. If there is only one element, npm assumes that the element
|
||||
represents a command to be run on the local repository\. If there is more than
|
||||
one element, then the first is assumed to be the package and the second is
|
||||
assumed to be the command to run\. All other elements are ignored\.
|
||||
.SH SEE ALSO
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
npm help 7 scripts
|
||||
.IP \(bu 2
|
||||
npm apihelp test
|
||||
.IP \(bu 2
|
||||
npm apihelp start
|
||||
.IP \(bu 2
|
||||
npm apihelp restart
|
||||
.IP \(bu 2
|
||||
npm apihelp stop
|
||||
|
||||
.RE
|
||||
|
52
node_modules/npm/man/man3/npm-search.3
generated
vendored
Normal file
52
node_modules/npm/man/man3/npm-search.3
generated
vendored
Normal file
@@ -0,0 +1,52 @@
|
||||
.TH "NPM\-SEARCH" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-search\fR \- Search for packages
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.search(searchTerms, [silent,] [staleness,] callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
Search the registry for packages matching the search terms\. The available parameters are:
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
searchTerms:
|
||||
Array of search terms\. These terms are case\-insensitive\.
|
||||
.IP \(bu 2
|
||||
silent:
|
||||
If true, npm will not log anything to the console\.
|
||||
.IP \(bu 2
|
||||
staleness:
|
||||
This is the threshold for stale packages\. "Fresh" packages are not refreshed
|
||||
from the registry\. This value is measured in seconds\.
|
||||
.IP \(bu 2
|
||||
callback:
|
||||
Returns an object where each key is the name of a package, and the value
|
||||
is information about that package along with a 'words' property, which is
|
||||
a space\-delimited string of all of the interesting words in that package\.
|
||||
The only properties included are those that are searched, which generally include:
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
name
|
||||
.IP \(bu 2
|
||||
description
|
||||
.IP \(bu 2
|
||||
maintainers
|
||||
.IP \(bu 2
|
||||
url
|
||||
.IP \(bu 2
|
||||
keywords
|
||||
|
||||
.RE
|
||||
|
||||
.RE
|
||||
.P
|
||||
A search on the registry excludes any result that does not match all of the
|
||||
search terms\. It also removes any items from the results that contain an
|
||||
excluded term (the "searchexclude" config)\. The search is case insensitive
|
||||
and doesn't try to read your mind (it doesn't do any verb tense matching or the
|
||||
like)\.
|
||||
|
24
node_modules/npm/man/man3/npm-shrinkwrap.3
generated
vendored
Normal file
24
node_modules/npm/man/man3/npm-shrinkwrap.3
generated
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
.TH "NPM\-SHRINKWRAP" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-shrinkwrap\fR \- programmatically generate package shrinkwrap file
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.shrinkwrap(args, [silent,] callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This acts much the same ways as shrinkwrapping on the command\-line\.
|
||||
.P
|
||||
This command does not take any arguments, but 'args' must be defined\.
|
||||
Beyond that, if any arguments are passed in, npm will politely warn that it
|
||||
does not take positional arguments\.
|
||||
.P
|
||||
If the 'silent' parameter is set to true, nothing will be output to the screen,
|
||||
but the shrinkwrap file will still be written\.
|
||||
.P
|
||||
Finally, 'callback' is a function that will be called when the shrinkwrap has
|
||||
been saved\.
|
||||
|
17
node_modules/npm/man/man3/npm-start.3
generated
vendored
Normal file
17
node_modules/npm/man/man3/npm-start.3
generated
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
.TH "NPM\-START" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-start\fR \- Start a package
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.start(packages, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This runs a package's "start" script, if one was provided\.
|
||||
.P
|
||||
npm can start multiple packages\. Just specify multiple packages in the
|
||||
\fBpackages\fP parameter\.
|
||||
|
17
node_modules/npm/man/man3/npm-stop.3
generated
vendored
Normal file
17
node_modules/npm/man/man3/npm-stop.3
generated
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
.TH "NPM\-STOP" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-stop\fR \- Stop a package
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.stop(packages, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This runs a package's "stop" script, if one was provided\.
|
||||
.P
|
||||
npm can run stop on multiple packages\. Just specify multiple packages
|
||||
in the \fBpackages\fP parameter\.
|
||||
|
27
node_modules/npm/man/man3/npm-tag.3
generated
vendored
Normal file
27
node_modules/npm/man/man3/npm-tag.3
generated
vendored
Normal file
@@ -0,0 +1,27 @@
|
||||
.TH "NPM\-TAG" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-tag\fR \- Tag a published version
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.tag(package@version, tag, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
Tags the specified version of the package with the specified tag, or the
|
||||
\fB\-\-tag\fP config if not specified\.
|
||||
.P
|
||||
The 'package@version' is an array of strings, but only the first two elements are
|
||||
currently used\.
|
||||
.P
|
||||
The first element must be in the form package@version, where package
|
||||
is the package name and version is the version number (much like installing a
|
||||
specific version)\.
|
||||
.P
|
||||
The second element is the name of the tag to tag this version with\. If this
|
||||
parameter is missing or falsey (empty), the default from the config will be
|
||||
used\. For more information about how to set this config, check
|
||||
\fBman 3 npm\-config\fP for programmatic usage or \fBman npm\-config\fP for cli usage\.
|
||||
|
20
node_modules/npm/man/man3/npm-test.3
generated
vendored
Normal file
20
node_modules/npm/man/man3/npm-test.3
generated
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
.TH "NPM\-TEST" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-test\fR \- Test a package
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.test(packages, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This runs a package's "test" script, if one was provided\.
|
||||
.P
|
||||
To run tests as a condition of installation, set the \fBnpat\fP config to
|
||||
true\.
|
||||
.P
|
||||
npm can run tests on multiple packages\. Just specify multiple packages
|
||||
in the \fBpackages\fP parameter\.
|
||||
|
20
node_modules/npm/man/man3/npm-uninstall.3
generated
vendored
Normal file
20
node_modules/npm/man/man3/npm-uninstall.3
generated
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
.TH "NPM\-UNINSTALL" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-uninstall\fR \- uninstall a package programmatically
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.uninstall(packages, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This acts much the same ways as uninstalling on the command\-line\.
|
||||
.P
|
||||
The 'packages' parameter is an array of strings\. Each element in the array is
|
||||
the name of a package to be uninstalled\.
|
||||
.P
|
||||
Finally, 'callback' is a function that will be called when all packages have been
|
||||
uninstalled or when an error has been encountered\.
|
||||
|
24
node_modules/npm/man/man3/npm-unpublish.3
generated
vendored
Normal file
24
node_modules/npm/man/man3/npm-unpublish.3
generated
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
.TH "NPM\-UNPUBLISH" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-unpublish\fR \- Remove a package from the registry
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.unpublish(package, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This removes a package version from the registry, deleting its
|
||||
entry and removing the tarball\.
|
||||
.P
|
||||
The package parameter must be defined\.
|
||||
.P
|
||||
Only the first element in the package parameter is used\. If there is no first
|
||||
element, then npm assumes that the package at the current working directory
|
||||
is what is meant\.
|
||||
.P
|
||||
If no version is specified, or if all versions are removed then
|
||||
the root package entry is removed from the registry entirely\.
|
||||
|
26
node_modules/npm/man/man3/npm-update.3
generated
vendored
Normal file
26
node_modules/npm/man/man3/npm-update.3
generated
vendored
Normal file
@@ -0,0 +1,26 @@
|
||||
.TH "NPM\-UPDATE" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-update\fR \- Update a package
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.update(packages, callback)
|
||||
.fi
|
||||
.RE
|
||||
.TH "DESCRIPTION" "" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBDESCRIPTION\fR
|
||||
.P
|
||||
Updates a package, upgrading it to the latest version\. It also installs any
|
||||
missing packages\.
|
||||
.P
|
||||
The \fBpackages\fP argument is an array of packages to update\. The \fBcallback\fP
|
||||
parameter will be called when done or when an error occurs\.
|
||||
.SH SEE ALSO
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
npm help update
|
||||
|
||||
.RE
|
||||
|
22
node_modules/npm/man/man3/npm-version.3
generated
vendored
Normal file
22
node_modules/npm/man/man3/npm-version.3
generated
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
.TH "NPM\-VERSION" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-version\fR \- Bump a package version
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.version(newversion, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
Run this in a package directory to bump the version and write the new
|
||||
data back to the package\.json file\.
|
||||
.P
|
||||
If run in a git repo, it will also create a version commit and tag, and
|
||||
fail if the repo is not clean\.
|
||||
.P
|
||||
Like all other commands, this function takes a string array as its first
|
||||
parameter\. The difference, however, is this function will fail if it does
|
||||
not have exactly one element\. The only element should be a version number\.
|
||||
|
131
node_modules/npm/man/man3/npm-view.3
generated
vendored
Normal file
131
node_modules/npm/man/man3/npm-view.3
generated
vendored
Normal file
@@ -0,0 +1,131 @@
|
||||
.TH "NPM\-VIEW" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-view\fR \- View registry info
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.view(args, [silent,] callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This command shows data about a package and prints it to the stream
|
||||
referenced by the \fBoutfd\fP config, which defaults to stdout\.
|
||||
.P
|
||||
The "args" parameter is an ordered list that closely resembles the command\-line
|
||||
usage\. The elements should be ordered such that the first element is
|
||||
the package and version (package@version)\. The version is optional\. After that,
|
||||
the rest of the parameters are fields with optional subfields ("field\.subfield")
|
||||
which can be used to get only the information desired from the registry\.
|
||||
.P
|
||||
The callback will be passed all of the data returned by the query\.
|
||||
.P
|
||||
For example, to get the package registry entry for the \fBconnect\fP package,
|
||||
you can do this:
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.view(["connect"], callback)
|
||||
.fi
|
||||
.RE
|
||||
.P
|
||||
If no version is specified, "latest" is assumed\.
|
||||
.P
|
||||
Field names can be specified after the package descriptor\.
|
||||
For example, to show the dependencies of the \fBronn\fP package at version
|
||||
0\.3\.5, you could do the following:
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.view(["ronn@0\.3\.5", "dependencies"], callback)
|
||||
.fi
|
||||
.RE
|
||||
.P
|
||||
You can view child field by separating them with a period\.
|
||||
To view the git repository URL for the latest version of npm, you could
|
||||
do this:
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.view(["npm", "repository\.url"], callback)
|
||||
.fi
|
||||
.RE
|
||||
.P
|
||||
For fields that are arrays, requesting a non\-numeric field will return
|
||||
all of the values from the objects in the list\. For example, to get all
|
||||
the contributor names for the "express" project, you can do this:
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.view(["express", "contributors\.email"], callback)
|
||||
.fi
|
||||
.RE
|
||||
.P
|
||||
You may also use numeric indices in square braces to specifically select
|
||||
an item in an array field\. To just get the email address of the first
|
||||
contributor in the list, you can do this:
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.view(["express", "contributors[0]\.email"], callback)
|
||||
.fi
|
||||
.RE
|
||||
.P
|
||||
Multiple fields may be specified, and will be printed one after another\.
|
||||
For exampls, to get all the contributor names and email addresses, you
|
||||
can do this:
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.view(["express", "contributors\.name", "contributors\.email"], callback)
|
||||
.fi
|
||||
.RE
|
||||
.P
|
||||
"Person" fields are shown as a string if they would be shown as an
|
||||
object\. So, for example, this will show the list of npm contributors in
|
||||
the shortened string format\. (See \fBnpm help json\fP for more on this\.)
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.view(["npm", "contributors"], callback)
|
||||
.fi
|
||||
.RE
|
||||
.P
|
||||
If a version range is provided, then data will be printed for every
|
||||
matching version of the package\. This will show which version of jsdom
|
||||
was required by each matching version of yui3:
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.view(["yui3@>0\.5\.4", "dependencies\.jsdom"], callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH OUTPUT
|
||||
.P
|
||||
If only a single string field for a single version is output, then it
|
||||
will not be colorized or quoted, so as to enable piping the output to
|
||||
another command\.
|
||||
.P
|
||||
If the version range matches multiple versions, than each printed value
|
||||
will be prefixed with the version it applies to\.
|
||||
.P
|
||||
If multiple fields are requested, than each of them are prefixed with
|
||||
the field name\.
|
||||
.P
|
||||
Console output can be disabled by setting the 'silent' parameter to true\.
|
||||
.SH RETURN VALUE
|
||||
.P
|
||||
The data returned will be an object in this formation:
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
{ <version>:
|
||||
{ <field>: <value>
|
||||
, \.\.\. }
|
||||
, \.\.\. }
|
||||
.fi
|
||||
.RE
|
||||
.P
|
||||
corresponding to the list of fields selected\.
|
||||
|
19
node_modules/npm/man/man3/npm-whoami.3
generated
vendored
Normal file
19
node_modules/npm/man/man3/npm-whoami.3
generated
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
.TH "NPM\-WHOAMI" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-whoami\fR \- Display npm username
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm\.commands\.whoami(args, callback)
|
||||
.fi
|
||||
.RE
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
Print the \fBusername\fP config to standard output\.
|
||||
.P
|
||||
\|'args' is never used and callback is never called with data\.
|
||||
\|'args' must be present or things will break\.
|
||||
.P
|
||||
This function is not useful programmatically
|
||||
|
124
node_modules/npm/man/man3/npm.3
generated
vendored
Normal file
124
node_modules/npm/man/man3/npm.3
generated
vendored
Normal file
@@ -0,0 +1,124 @@
|
||||
.TH "NPM" "3" "March 2017" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm\fR \- javascript package manager
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
var npm = require("npm")
|
||||
npm\.load([configObject, ]function (er, npm) {
|
||||
// use the npm object, now that it's loaded\.
|
||||
|
||||
npm\.config\.set(key, val)
|
||||
val = npm\.config\.get(key)
|
||||
|
||||
console\.log("prefix = %s", npm\.prefix)
|
||||
|
||||
npm\.commands\.install(["package"], cb)
|
||||
})
|
||||
.fi
|
||||
.RE
|
||||
.SH VERSION
|
||||
.P
|
||||
2.15.12
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
This is the API documentation for npm\.
|
||||
To find documentation of the command line
|
||||
client, see npm help \fBnpm\fP\|\.
|
||||
.P
|
||||
Prior to using npm's commands, \fBnpm\.load()\fP must be called\. If you provide
|
||||
\fBconfigObject\fP as an object map of top\-level configs, they override the values
|
||||
stored in the various config locations\. In the npm command line client, this
|
||||
set of configs is parsed from the command line options\. Additional
|
||||
configuration params are loaded from two configuration files\. See
|
||||
npm help \fBnpm\-config\fP, npm help 7 \fBnpm\-config\fP, and npm help 5 \fBnpmrc\fP for more information\.
|
||||
.P
|
||||
After that, each of the functions are accessible in the
|
||||
commands object: \fBnpm\.commands\.<cmd>\fP\|\. See npm help 7 \fBnpm\-index\fP for a list of
|
||||
all possible commands\.
|
||||
.P
|
||||
All commands on the command object take an \fBarray\fR of positional argument
|
||||
\fBstrings\fR\|\. The last argument to any function is a callback\. Some
|
||||
commands take other optional arguments\.
|
||||
.P
|
||||
Configs cannot currently be set on a per function basis, as each call to
|
||||
npm\.config\.set will change the value for \fIall\fR npm commands in that process\.
|
||||
.P
|
||||
To find API documentation for a specific command, run the \fBnpm apihelp\fP
|
||||
command\.
|
||||
.SH METHODS AND PROPERTIES
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
\fBnpm\.load(configs, cb)\fP
|
||||
Load the configuration params, and call the \fBcb\fP function once the
|
||||
globalconfig and userconfig files have been loaded as well, or on
|
||||
nextTick if they've already been loaded\.
|
||||
.IP \(bu 2
|
||||
\fBnpm\.config\fP
|
||||
An object for accessing npm configuration parameters\.
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
\fBnpm\.config\.get(key)\fP
|
||||
.IP \(bu 2
|
||||
\fBnpm\.config\.set(key, val)\fP
|
||||
.IP \(bu 2
|
||||
\fBnpm\.config\.del(key)\fP
|
||||
|
||||
.RE
|
||||
.IP \(bu 2
|
||||
\fBnpm\.dir\fP or \fBnpm\.root\fP
|
||||
The \fBnode_modules\fP directory where npm will operate\.
|
||||
.IP \(bu 2
|
||||
\fBnpm\.prefix\fP
|
||||
The prefix where npm is operating\. (Most often the current working
|
||||
directory\.)
|
||||
.IP \(bu 2
|
||||
\fBnpm\.cache\fP
|
||||
The place where npm keeps JSON and tarballs it fetches from the
|
||||
registry (or uploads to the registry)\.
|
||||
.IP \(bu 2
|
||||
\fBnpm\.tmp\fP
|
||||
npm's temporary working directory\.
|
||||
.IP \(bu 2
|
||||
\fBnpm\.deref\fP
|
||||
Get the "real" name for a command that has either an alias or
|
||||
abbreviation\.
|
||||
|
||||
.RE
|
||||
.SH MAGIC
|
||||
.P
|
||||
For each of the methods in the \fBnpm\.commands\fP object, a method is added to the
|
||||
npm object, which takes a set of positional string arguments rather than an
|
||||
array and a callback\.
|
||||
.P
|
||||
If the last argument is a callback, then it will use the supplied
|
||||
callback\. However, if no callback is provided, then it will print out
|
||||
the error or results\.
|
||||
.P
|
||||
For example, this would work in a node repl:
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
> npm = require("npm")
|
||||
> npm\.load() // wait a sec\.\.\.
|
||||
> npm\.install("dnode", "express")
|
||||
.fi
|
||||
.RE
|
||||
.P
|
||||
Note that that \fIwon't\fR work in a node program, since the \fBinstall\fP
|
||||
method will get called before the configuration load is completed\.
|
||||
.SH ABBREVS
|
||||
.P
|
||||
In order to support \fBnpm ins foo\fP instead of \fBnpm install foo\fP, the
|
||||
\fBnpm\.commands\fP object has a set of abbreviations as well as the full
|
||||
method names\. Use the \fBnpm\.deref\fP method to find the real name\.
|
||||
.P
|
||||
For example:
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
var cmd = npm\.deref("unp") // cmd === "unpublish"
|
||||
.fi
|
||||
.RE
|
||||
|
Reference in New Issue
Block a user