2015-02-06 17:14:25 +08:00
|
|
|
.TH "NPM\-DEPRECATE" "3" "February 2015" "" ""
|
2011-11-27 01:21:03 +08:00
|
|
|
.SH "NAME"
|
2014-09-25 05:41:07 +08:00
|
|
|
\fBnpm-deprecate\fR \- Deprecate a version of a package
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.P
|
|
|
|
|
.RS 2
|
2014-11-05 07:08:12 +08:00
|
|
|
.nf
|
2011-11-27 01:21:03 +08:00
|
|
|
npm\.commands\.deprecate(args, callback)
|
2014-11-05 07:08:12 +08:00
|
|
|
.fi
|
2014-09-25 05:41:07 +08:00
|
|
|
.RE
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.P
|
2011-11-27 01:21:03 +08:00
|
|
|
This command will update the npm registry entry for a package, providing
|
|
|
|
|
a deprecation warning to all who attempt to install it\.
|
|
|
|
|
.P
|
2014-09-25 05:41:07 +08:00
|
|
|
The 'args' parameter must have exactly two elements:
|
|
|
|
|
.RS 0
|
|
|
|
|
.IP \(bu 2
|
2011-11-27 01:21:03 +08:00
|
|
|
\fBpackage[@version]\fR
|
2014-09-25 05:41:07 +08:00
|
|
|
The \fBversion\fR portion is optional, and may be either a range, or a
|
|
|
|
|
specific version, or a tag\.
|
|
|
|
|
.IP \(bu 2
|
2011-11-27 01:21:03 +08:00
|
|
|
\fBmessage\fR
|
2014-09-25 05:41:07 +08:00
|
|
|
The warning message that will be printed whenever a user attempts to
|
|
|
|
|
install the package\.
|
|
|
|
|
|
|
|
|
|
.RE
|
2011-11-27 01:21:03 +08:00
|
|
|
.P
|
2014-09-25 05:41:07 +08:00
|
|
|
Note that you must be the package owner to deprecate something\. See the
|
|
|
|
|
\fBowner\fR and \fBadduser\fR help topics\.
|
2012-12-22 00:42:29 +08:00
|
|
|
.P
|
|
|
|
|
To un\-deprecate a package, specify an empty string (\fB""\fR) for the \fBmessage\fR argument\.
|
2014-09-25 05:41:07 +08:00
|
|
|
.SH SEE ALSO
|
|
|
|
|
.RS 0
|
|
|
|
|
.IP \(bu 2
|
2011-11-27 01:21:03 +08:00
|
|
|
npm apihelp publish
|
2014-09-25 05:41:07 +08:00
|
|
|
.IP \(bu 2
|
2011-11-27 01:21:03 +08:00
|
|
|
npm apihelp unpublish
|
2014-09-25 05:41:07 +08:00
|
|
|
.IP \(bu 2
|
2014-09-17 06:38:50 +08:00
|
|
|
npm help 7 registry
|
2014-09-25 05:41:07 +08:00
|
|
|
|
|
|
|
|
.RE
|
2011-11-27 01:21:03 +08:00
|
|
|
|
