summaryrefslogtreecommitdiff
path: root/deps/npm/man/man3/deprecate.3
blob: c9a7ecb79a9a0e8c2f732dc37583c8637a423f26 (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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
.\" Generated with Ronnjs 0.3.8
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-DEPRECATE" "3" "January 2013" "" ""
.
.SH "NAME"
\fBnpm-deprecate\fR \-\- Deprecate a version of a package
.
.SH "SYNOPSIS"
.
.nf
npm\.commands\.deprecate(args, callback)
.
.fi
.
.SH "DESCRIPTION"
This command will update the npm registry entry for a package, providing
a deprecation warning to all who attempt to install it\.
.
.P
The \'args\' parameter must have exactly two elements:
.
.IP "\(bu" 4
\fBpackage[@version]\fR
.
.IP
The \fBversion\fR portion is optional, and may be either a range, or a
specific version, or a tag\.
.
.IP "\(bu" 4
\fBmessage\fR
.
.IP
The warning message that will be printed whenever a user attempts to
install the package\.
.
.IP "" 0
.
.P
Note that you must be the package owner to deprecate something\.  See the \fBowner\fR and \fBadduser\fR help topics\.
.
.P
To un\-deprecate a package, specify an empty string (\fB""\fR) for the \fBmessage\fR argument\.
.
.SH "SEE ALSO"
.
.IP "\(bu" 4
npm apihelp publish
.
.IP "\(bu" 4
npm apihelp unpublish
.
.IP "\(bu" 4
npm help registry
.
.IP "" 0