summaryrefslogtreecommitdiff
path: root/deps/npm/man/man1/npm-deprecate.1
blob: 5024b4782999543fbfe6f942d3bd4f3510c68e34 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
.TH "NPM\-DEPRECATE" "1" "August 2020" "" ""
.SH "NAME"
\fBnpm-deprecate\fR \- Deprecate a version of a package
.SS Synopsis
.P
.RS 2
.nf
npm deprecate <pkg>[@<version>] <message>
.fi
.RE
.SS Description
.P
This command will update the npm registry entry for a package, providing
a deprecation warning to all who attempt to install it\.
.P
It works on version ranges \fIhttps://semver\.npmjs\.com/\fR as well as specific 
versions, so you can do something like this:
.P
.RS 2
.nf
npm deprecate my\-thing@"< 0\.2\.3" "critical bug fixed in v0\.2\.3"
.fi
.RE
.P
Note that you must be the package owner to deprecate something\.  See the
\fBowner\fP and \fBadduser\fP help topics\.
.P
To un\-deprecate a package, specify an empty string (\fB""\fP) for the \fBmessage\fP 
argument\. Note that you must use double quotes with no space between them to 
format an empty string\.
.SS See Also
.RS 0
.IP \(bu 2
npm help publish
.IP \(bu 2
npm help registry

.RE