1NPM-DEPRECATE(1) NPM-DEPRECATE(1)
2
3
4
6 npm-deprecate - Deprecate a version of a package
7
8 Synopsis
9 npm deprecate <pkg>[@<version range>] <message>
10
11 Note: This command is unaware of workspaces.
12
13 Description
14 This command will update the npm registry entry for a package, provid‐
15 ing a deprecation warning to all who attempt to install it.
16
17 It works on version ranges https://semver.npmjs.com/ as well as spe‐
18 cific versions, so you can do something like this:
19
20 npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
21
22 SemVer ranges passed to this command are interpreted such that they do
23 include prerelease versions. For example:
24
25 npm deprecate my-thing@1.x "1.x is no longer supported"
26
27 In this case, a version my-thing@1.0.0-beta.0 will also be deprecated.
28
29 You must be the package owner to deprecate something. See the owner
30 and adduser help topics.
31
32 To un-deprecate a package, specify an empty string ("") for the message
33 argument. Note that you must use double quotes with no space between
34 them to format an empty string.
35
36 Configuration
37 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically
38 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
39 tions.js -->
40
41 registry
42 • Default: "https://registry.npmjs.org/"
43
44 • Type: URL
45
46
47 The base URL of the npm registry. <!-- automatically generated, do not
48 edit manually --> <!-- see lib/utils/config/definitions.js -->
49
50
51 otp
52 • Default: null
53
54 • Type: null or String
55
56
57 This is a one-time password from a two-factor authenticator. It's
58 needed when publishing or changing package permissions with npm access.
59
60 If not set, and a registry response fails with a challenge for a
61 one-time password, npm will prompt on the command line for one. <!--
62 automatically generated, do not edit manually --> <!-- see
63 lib/utils/config/definitions.js -->
64
65 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
66
67
68 See Also
69 • npm help publish
70
71 • npm help registry
72
73 • npm help owner
74
75 • npm help adduser
76
77
78
79
80 January 2022 NPM-DEPRECATE(1)