summaryrefslogtreecommitdiff
path: root/deps/npm/doc/api/shrinkwrap.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/doc/api/shrinkwrap.md')
-rw-r--r--deps/npm/doc/api/shrinkwrap.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/deps/npm/doc/api/shrinkwrap.md b/deps/npm/doc/api/shrinkwrap.md
new file mode 100644
index 0000000000..6584d6a0da
--- /dev/null
+++ b/deps/npm/doc/api/shrinkwrap.md
@@ -0,0 +1,20 @@
+npm-shrinkwrap(3) -- programmatically generate package shrinkwrap file
+====================================================
+
+## SYNOPSIS
+
+ npm.commands.shrinkwrap(args, [silent,] callback)
+
+## DESCRIPTION
+
+This acts much the same ways as shrinkwrapping on the command-line.
+
+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.
+
+If the 'silent' parameter is set to true, nothing will be output to the screen,
+but the shrinkwrap file will still be written.
+
+Finally, 'callback' is a function that will be called when the shrinkwrap has
+been saved.