node/deps/npm/man/man3/npm-shrinkwrap.3

25 lines
718 B
Groff
Raw Normal View History

.TH "NPM\-SHRINKWRAP" "3" "March 2015" "" ""
2012-02-25 10:52:17 +08:00
.SH "NAME"
2014-09-25 05:41:07 +08:00
\fBnpm-shrinkwrap\fR \- programmatically generate package shrinkwrap file
.SH SYNOPSIS
.P
.RS 2
2014-11-05 07:08:12 +08:00
.nf
2012-02-25 10:52:17 +08:00
npm\.commands\.shrinkwrap(args, [silent,] callback)
2014-11-05 07:08:12 +08:00
.fi
2014-09-25 05:41:07 +08:00
.RE
.SH DESCRIPTION
.P
2012-02-25 10:52:17 +08:00
This acts much the same ways as shrinkwrapping on the command\-line\.
.P
2014-09-25 05:41:07 +08:00
This command does not take any arguments, but 'args' must be defined\.
2012-02-25 10:52:17 +08:00
Beyond that, if any arguments are passed in, npm will politely warn that it
does not take positional arguments\.
.P
2014-09-25 05:41:07 +08:00
If the 'silent' parameter is set to true, nothing will be output to the screen,
2012-02-25 10:52:17 +08:00
but the shrinkwrap file will still be written\.
.P
2014-09-25 05:41:07 +08:00
Finally, 'callback' is a function that will be called when the shrinkwrap has
2012-02-25 10:52:17 +08:00
been saved\.
2014-09-25 05:41:07 +08:00