diff options
author | isaacs <i@izs.me> | 2012-02-24 18:52:17 -0800 |
---|---|---|
committer | isaacs <i@izs.me> | 2012-02-24 18:52:17 -0800 |
commit | ca0986fbd1a8ade47f3160853a257b6ae83a2151 (patch) | |
tree | 7a86f9b6ff5b046d800fab15d51d220b2b3b476e /deps/npm/doc/api | |
parent | e004721b482198fb9558f920f8101b27fb0bcb7c (diff) | |
download | node-ca0986fbd1a8ade47f3160853a257b6ae83a2151.tar.gz |
Update npm to 1.1.2
Diffstat (limited to 'deps/npm/doc/api')
-rw-r--r-- | deps/npm/doc/api/ls.md | 6 | ||||
-rw-r--r-- | deps/npm/doc/api/shrinkwrap.md | 20 |
2 files changed, 26 insertions, 0 deletions
diff --git a/deps/npm/doc/api/ls.md b/deps/npm/doc/api/ls.md index a6c0a1382..ed890ff14 100644 --- a/deps/npm/doc/api/ls.md +++ b/deps/npm/doc/api/ls.md @@ -21,6 +21,12 @@ It will print out extraneous, missing, and invalid packages. If the silent parameter is set to true, nothing will be output to the screen, but the data will still be returned. +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. + ## CONFIGURATION ### long diff --git a/deps/npm/doc/api/shrinkwrap.md b/deps/npm/doc/api/shrinkwrap.md new file mode 100644 index 000000000..6584d6a0d --- /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. |