| <!doctype html> |
| <html> |
| <title>npm-deprecate</title> |
| <meta http-equiv="content-type" value="text/html;utf-8"> |
| <link rel="stylesheet" type="text/css" href="../../static/style.css"> |
| |
| <body> |
| <div id="wrapper"> |
| <h1><a href="../api/npm-deprecate.html">npm-deprecate</a></h1> <p>Deprecate a version of a package</p> |
| |
| <h2 id="SYNOPSIS">SYNOPSIS</h2> |
| |
| <pre><code>npm.commands.deprecate(args, callback)</code></pre> |
| |
| <h2 id="DESCRIPTION">DESCRIPTION</h2> |
| |
| <p>This command will update the npm registry entry for a package, providing |
| a deprecation warning to all who attempt to install it.</p> |
| |
| <p>The 'args' parameter must have exactly two elements:</p> |
| |
| <ul><li><p><code>package[@version]</code></p><p>The <code>version</code> portion is optional, and may be either a range, or a |
| specific version, or a tag.</p></li><li><p><code>message</code></p><p>The warning message that will be printed whenever a user attempts to |
| install the package.</p></li></ul> |
| |
| <p>Note that you must be the package owner to deprecate something. See the |
| <code>owner</code> and <code>adduser</code> help topics.</p> |
| |
| <p>To un-deprecate a package, specify an empty string (<code>""</code>) for the <code>message</code> argument.</p> |
| |
| <h2 id="SEE-ALSO">SEE ALSO</h2> |
| |
| <ul><li><a href="../api/npm-publish.html">npm-publish(3)</a></li><li><a href="../api/npm-unpublish.html">npm-unpublish(3)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li></ul> |
| </div> |
| <p id="footer">npm-deprecate — npm@1.3.21</p> |
| <script> |
| ;(function () { |
| var wrapper = document.getElementById("wrapper") |
| var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0) |
| .filter(function (el) { |
| return el.parentNode === wrapper |
| && el.tagName.match(/H[1-6]/) |
| && el.id |
| }) |
| var l = 2 |
| , toc = document.createElement("ul") |
| toc.innerHTML = els.map(function (el) { |
| var i = el.tagName.charAt(1) |
| , out = "" |
| while (i > l) { |
| out += "<ul>" |
| l ++ |
| } |
| while (i < l) { |
| out += "</ul>" |
| l -- |
| } |
| out += "<li><a href='#" + el.id + "'>" + |
| ( el.innerText || el.text || el.innerHTML) |
| + "</a>" |
| return out |
| }).join("\n") |
| toc.id = "toc" |
| document.body.appendChild(toc) |
| })() |
| </script> |
