| <!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"> |
| <link rel="canonical" href="https://www.npmjs.org/doc/api/npm-deprecate.html"> |
| <script async=true src="../../static/toc.js"></script> |
| |
| <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> |
| |
| <table border=0 cellspacing=0 cellpadding=0 id=npmlogo> |
| <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr> |
| <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr> |
| <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr> |
| <tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr> |
| <tr><td style="width:10px;height:10px;background:#fff"> </td></tr> |
| <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> |
| <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> |
| </table> |
| <p id="footer">npm-deprecate — npm@2.15.8</p> |
| |
