npm-deprecate.1 952 B

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