deps/npm/html/api/deprecate.html

   1 <!doctype html>
   2 <html>
   3   <title>deprecate</title>
   4   <meta http-equiv="content-type" value="text/html;utf-8">
   5   <link rel="stylesheet" type="text/css" href="./style.css">
   6
   7   <body>
   8     <div id="wrapper">
   9 <h1><a href="../api/deprecate.html">deprecate</a></h1> <p>Deprecate a version of a package</p>
  10
  11 <h2 id="SYNOPSIS">SYNOPSIS</h2>
  12
  13 <pre><code>npm.commands.deprecate(args, callback)</code></pre>
  14
  15 <h2 id="DESCRIPTION">DESCRIPTION</h2>
  16
  17 <p>This command will update the npm registry entry for a package, providing
  18 a deprecation warning to all who attempt to install it.</p>
  19
  20 <p>The 'args' parameter must have exactly two elements:</p>
  21
  22 <ul><li><p><code>package[@version]</code></p><p>The <code>version</code> portion is optional, and may be either a range, or a
  23 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
  24 install the package.</p></li></ul>
  25
  26 <p>Note that you must be the package owner to deprecate something.  See the
  27 <code>owner</code> and <code>adduser</code> help topics.</p>
  28
  29 <h2 id="SEE-ALSO">SEE ALSO</h2>
  30
  31 <ul><li><a href="../api/publish.html">publish(3)</a></li><li><a href="../api/unpublish.html">unpublish(3)</a></li><li><a href="../doc/registry.html">registry(1)</a></li></ul>
  32 </div>
  33 <p id="footer">deprecate &mdash; npm@1.1.0-2</p>
  34 <script>
  35 ;(function () {
  36 var wrapper = document.getElementById("wrapper")
  37 var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
  38   .filter(function (el) {
  39     return el.parentNode === wrapper
  40         && el.tagName.match(/H[1-6]/)
  41         && el.id
  42   })
  43 var l = 2
  44   , toc = document.createElement("ul")
  45 toc.innerHTML = els.map(function (el) {
  46   var i = el.tagName.charAt(1)
  47     , out = ""
  48   while (i > l) {
  49     out += "<ul>"
  50     l ++
  51   }
  52   while (i < l) {
  53     out += "</ul>"
  54     l --
  55   }
  56   out += "<li><a href='#" + el.id + "'>" +
  57     ( el.innerText || el.text || el.innerHTML)
  58     + "</a>"
  59   return out
  60 }).join("\n")
  61 toc.id = "toc"
  62 document.body.appendChild(toc)
  63 })()
  64 </script>
  65 </body></html>