codekingpro/portable-devtools
114k
1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-deprecate</title>
4<style>
5body {
6 background-color: #ffffff;
7 color: #24292e;
8
9 margin: 0;
10
11 line-height: 1.5;
12
13 font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
14}
15#rainbar {
16 height: 10px;
17 background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
18}
19
20a {
21 text-decoration: none;
22 color: #0366d6;
23}
24a:hover {
25 text-decoration: underline;
26}
27
28pre {
29 margin: 1em 0px;
30 padding: 1em;
31 border: solid 1px #e1e4e8;
32 border-radius: 6px;
33
34 display: block;
35 overflow: auto;
36
37 white-space: pre;
38
39 background-color: #f6f8fa;
40 color: #393a34;
41}
42code {
43 font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
44 font-size: 85%;
45 padding: 0.2em 0.4em;
46 background-color: #f6f8fa;
47 color: #393a34;
48}
49pre > code {
50 padding: 0;
51 background-color: inherit;
52 color: inherit;
53}
54h1, h2, h3 {
55 font-weight: 600;
56}
57
58#logobar {
59 background-color: #333333;
60 margin: 0 auto;
61 padding: 1em 4em;
62}
63#logobar .logo {
64 float: left;
65}
66#logobar .title {
67 font-weight: 600;
68 color: #dddddd;
69 float: left;
70 margin: 5px 0 0 1em;
71}
72#logobar:after {
73 content: "";
74 display: block;
75 clear: both;
76}
77
78#content {
79 margin: 0 auto;
80 padding: 0 4em;
81}
82
83#table_of_contents > h2 {
84 font-size: 1.17em;
85}
86#table_of_contents ul:first-child {
87 border: solid 1px #e1e4e8;
88 border-radius: 6px;
89 padding: 1em;
90 background-color: #f6f8fa;
91 color: #393a34;
92}
93#table_of_contents ul {
94 list-style-type: none;
95 padding-left: 1.5em;
96}
97#table_of_contents li {
98 font-size: 0.9em;
99}
100#table_of_contents li a {
101 color: #000000;
102}
103
104header.title {
105 border-bottom: solid 1px #e1e4e8;
106}
107header.title > h1 {
108 margin-bottom: 0.25em;
109}
110header.title > .description {
111 display: block;
112 margin-bottom: 0.5em;
113 line-height: 1;
114}
115
116header.title .version {
117 font-size: 0.8em;
118 color: #666666;
119}
120
121footer#edit {
122 border-top: solid 1px #e1e4e8;
123 margin: 3em 0 4em 0;
124 padding-top: 2em;
125}
126
127table {
128 width: 100%;
129 margin: 1em 0;
130 border-radius: 6px;
131 border: 1px solid #e1e4e8;
132 overflow: hidden;
133 border-collapse: separate;
134 border-spacing: 0;
135}
136
137table thead {
138 background-color: #f6f8fa;
139}
140
141table tbody {
142 background-color: #ffffff;
143}
144
145table th,
146table td {
147 padding: 0.75em;
148 text-align: left;
149 border-right: 1px solid #e1e4e8;
150 border-bottom: 1px solid #e1e4e8;
151}
152
153table th:last-child,
154table td:last-child {
155 border-right: none;
156}
157
158table tbody tr:last-child td {
159 border-bottom: none;
160}
161
162table th {
163 font-weight: 600;
164 background-color: #f6f8fa;
165}
166
167table code {
168 white-space: nowrap;
169}
170
171</style>
172</head>
173<body>
174<div id="banner">
175<div id="rainbar"></div>
176<div id="logobar">
177<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
178<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
179<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
180</svg>
181<div class="title">
182npm command-line interface
183</div>
184</div>
185</div>
186
187<section id="content">
188<header class="title">
189<h1 id="----npm-deprecate----11121">
190 <span>npm-deprecate</span>
191 <span class="version">@11.12.1</span>
192</h1>
193<span class="description">Deprecate a version of a package</span>
194</header>
195
196<section id="table_of_contents">
197<h2 id="table-of-contents">Table of contents</h2>
198<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#registry"><code>registry</code></a></li><li><a href="#otp"><code>otp</code></a></li><li><a href="#dry-run"><code>dry-run</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
199</section>
200
201<div id="_content"><h3 id="synopsis">Synopsis</h3>
202<pre><code class="language-bash">npm deprecate <package-spec> <message>
203</code></pre>
204<p>Note: This command is unaware of workspaces.</p>
205<h3 id="description">Description</h3>
206<p>This command will update the npm registry entry for a package, providing a deprecation warning to all who attempt to install it.</p>
207<p>It works on <a href="https://semver.npmjs.com/">version ranges</a> as well as specific versions, so you can do something like this:</p>
208<pre><code class="language-bash">npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
209</code></pre>
210<p>SemVer ranges passed to this command are interpreted such that they <em>do</em> include prerelease versions.
211For example:</p>
212<pre><code class="language-bash">npm deprecate my-thing@1.x "1.x is no longer supported"
213</code></pre>
214<p>In this case, a version <code>my-thing@1.0.0-beta.0</code> will also be deprecated.</p>
215<p>You must be the package owner to deprecate something.
216See the <code>owner</code> and <code>adduser</code> help topics.</p>
217<p>To un-deprecate a package, specify an empty string (<code>""</code>) for the <code>message</code> argument.
218Note that you must use double quotes with no space between them to format an empty string.</p>
219<h3 id="configuration">Configuration</h3>
220<h4 id="registry"><code>registry</code></h4>
221<ul>
222<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
223<li>Type: URL</li>
224</ul>
225<p>The base URL of the npm registry.</p>
226<h4 id="otp"><code>otp</code></h4>
227<ul>
228<li>Default: null</li>
229<li>Type: null or String</li>
230</ul>
231<p>This is a one-time password from a two-factor authenticator. It's needed
232when publishing or changing package permissions with <code>npm access</code>.</p>
233<p>If not set, and a registry response fails with a challenge for a one-time
234password, npm will prompt on the command line for one.</p>
235<h4 id="dry-run"><code>dry-run</code></h4>
236<ul>
237<li>Default: false</li>
238<li>Type: Boolean</li>
239</ul>
240<p>Indicates that you don't want npm to make any changes and that it should
241only report what it would have done. This can be passed into any of the
242commands that modify your local installation, eg, <code>install</code>, <code>update</code>,
243<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
244<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
245<code>owner</code>, etc.</p>
246<h3 id="see-also">See Also</h3>
247<ul>
248<li><a href="../using-npm/package-spec.html">package spec</a></li>
249<li><a href="../commands/npm-publish.html">npm publish</a></li>
250<li><a href="../using-npm/registry.html">npm registry</a></li>
251<li><a href="../commands/npm-owner.html">npm owner</a></li>
252<li><a href="../commands/npm-adduser.html">npm adduser</a></li>
253</ul></div>
254
255<footer id="edit">
256<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-deprecate.md">
257<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
258<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
259</svg>
260Edit this page on GitHub
261</a>
262</footer>
263</section>
264
265
266
267</body></html>