summaryrefslogtreecommitdiff
path: root/deps/npm/doc/api/unpublish.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/doc/api/unpublish.md')
-rw-r--r--deps/npm/doc/api/unpublish.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/deps/npm/doc/api/unpublish.md b/deps/npm/doc/api/unpublish.md
new file mode 100644
index 0000000000..6cbc5c1f37
--- /dev/null
+++ b/deps/npm/doc/api/unpublish.md
@@ -0,0 +1,20 @@
+npm-unpublish(3) -- Remove a package from the registry
+======================================================
+
+## SYNOPSIS
+
+ npm.commands.unpublish(package, callback)
+
+## DESCRIPTION
+
+This removes a package version from the registry, deleting its
+entry and removing the tarball.
+
+The package parameter must be defined.
+
+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.
+
+If no version is specified, or if all versions are removed then
+the root package entry is removed from the registry entirely.