npm/html/partial/doc/api/npm-deprecate.html

A package manager for node

<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 &#39;args&#39; 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>&quot;&quot;</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>