Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 9, 2022
 
 

npm-deprecate (1)

Name

npm-deprecate - Deprecate a version of a package Synopsis npm deprecate <pkg>[@<version range>] <message> Note: This command is unaware of workspaces. Description This command will update the npm registry entry for a package, provid- ing a deprecation warning to all who attempt to install it. It works on version ranges https://semver.npmjs.com/ as well as spe- cific versions, so you can do something like this: npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3" SemVer ranges passed to this command are interpreted such that they do include prerelease versions. For example: npm deprecate my-thing@1.x "1.x is no longer supported" In this case, a version my-thing@1.0.0-beta.0 will also be deprecated. You must be the package owner to deprecate something. See the owner and adduser help topics. To un-deprecate a package, specify an empty string ("") for the message argument. Note that you must use double quotes with no space between them to format an empty string. Configuration <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/defini- tions.js --> registry o Default: "https://registry.npmjs.org/" o Type: URL The base URL of the npm registry. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> otp o Default: null o Type: null or String This is a one-time password from a two-factor authenticator. It's needed when publishing or changing package permissions with npm access. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> See Also o npm help publish o npm help registry o npm help owner o npm help adduser

Synopsis

Please see following description for synopsis

Description

NPM-DEPRECATE(1)                                              NPM-DEPRECATE(1)



NAME
       npm-deprecate - Deprecate a version of a package

   Synopsis
         npm deprecate <pkg>[@<version range>] <message>

       Note: This command is unaware of workspaces.

   Description
       This  command will update the npm registry entry for a package, provid-
       ing a deprecation warning to all who attempt to install it.

       It works on version ranges https://semver.npmjs.com/ as  well  as  spe-
       cific versions, so you can do something like this:

         npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"

       SemVer  ranges passed to this command are interpreted such that they do
       include prerelease versions.  For example:

         npm deprecate my-thing@1.x "1.x is no longer supported"

       In this case, a version my-thing@1.0.0-beta.0 will also be deprecated.

       You must be the package owner to deprecate something.   See  the  owner
       and adduser help topics.

       To un-deprecate a package, specify an empty string ("") for the message
       argument. Note that you must use double quotes with  no  space  between
       them to format an empty string.

   Configuration
       <!--  AUTOGENERATED  CONFIG  DESCRIPTIONS  START --> <!-- automatically
       generated, do not edit manually --> <!--  see  lib/utils/config/defini-
       tions.js -->

   registry
       o Default: "https://registry.npmjs.org/"

       o Type: URL


       The base URL of the npm registry.  <!-- automatically generated, do not
       edit manually --> <!-- see lib/utils/config/definitions.js -->


   otp
       o Default: null

       o Type: null or String


       This is a one-time  password  from  a  two-factor  authenticator.  It's
       needed when publishing or changing package permissions with npm access.

       If  not  set,  and  a  registry  response  fails with a challenge for a
       one-time password, npm will prompt on the command line for  one.   <!--
       automatically   generated,   do   not   edit   manually  -->  <!--  see
       lib/utils/config/definitions.js -->

       <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->


   See Also
       o npm help publish

       o npm help registry

       o npm help owner

       o npm help adduser




ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | runtime/nodejs/nodejs-16 |
       +---------------+--------------------------+
       |Stability      | Pass-thru volatile       |
       +---------------+--------------------------+

NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was   downloaded   from     https://github.com/nodejs/node/ar-
       chive/v16.11.1.zip.

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                 October 2021                 NPM-DEPRECATE(1)