Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2013-07-11 12:25:45 +0400
committerisaacs <i@izs.me>2013-07-11 12:25:45 +0400
commit420db7dd7c4a16a069391fc280d9065631a678ca (patch)
tree61fe6442fae2ef224df981b19362ae1dc9e0bd7e /doc/api/npm-uninstall.md
parentc8596f30af057039934457694ac955224fa8b247 (diff)
doc: organize into sections
Diffstat (limited to 'doc/api/npm-uninstall.md')
-rw-r--r--doc/api/npm-uninstall.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/api/npm-uninstall.md b/doc/api/npm-uninstall.md
new file mode 100644
index 000000000..4505295b3
--- /dev/null
+++ b/doc/api/npm-uninstall.md
@@ -0,0 +1,16 @@
+npm-uninstall(3) -- uninstall a package programmatically
+========================================================
+
+## SYNOPSIS
+
+ npm.commands.uninstall(packages, callback)
+
+## DESCRIPTION
+
+This acts much the same ways as uninstalling on the command-line.
+
+The 'packages' parameter is an array of strings. Each element in the array is
+the name of a package to be uninstalled.
+
+Finally, 'callback' is a function that will be called when all packages have been
+uninstalled or when an error has been encountered.