mirror of
https://github.com/zebrajr/node.git
synced 2025-12-06 00:20:08 +01:00
1b22f6049a
PR-URL: https://github.com/nodejs/node/pull/60168 Reviewed-By: Jordan Harband <ljharb@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
88 lines
2.1 KiB
Markdown
88 lines
2.1 KiB
Markdown
---
|
|
title: npm-deprecate
|
|
section: 1
|
|
description: Deprecate a version of a package
|
|
---
|
|
|
|
### Synopsis
|
|
|
|
```bash
|
|
npm deprecate <package-spec> <message>
|
|
```
|
|
|
|
Note: This command is unaware of workspaces.
|
|
|
|
### Description
|
|
|
|
This command will update the npm registry entry for a package, providing a deprecation warning to all who attempt to install it.
|
|
|
|
It works on [version ranges](https://semver.npmjs.com/) as well as specific versions, so you can do something like this:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
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
|
|
|
|
#### `registry`
|
|
|
|
* Default: "https://registry.npmjs.org/"
|
|
* Type: URL
|
|
|
|
The base URL of the npm registry.
|
|
|
|
|
|
|
|
#### `otp`
|
|
|
|
* Default: null
|
|
* 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.
|
|
|
|
|
|
|
|
#### `dry-run`
|
|
|
|
* Default: false
|
|
* Type: Boolean
|
|
|
|
Indicates that you don't want npm to make any changes and that it
|
|
should only report what it would have done. This can be passed into
|
|
any of the commands that modify your local installation, eg,
|
|
`install`, `update`, `dedupe`, `uninstall`, as well as `pack` and
|
|
`publish`.
|
|
|
|
Note: This is NOT honored by other network related commands, eg
|
|
`dist-tags`, `owner`, etc.
|
|
|
|
|
|
|
|
### See Also
|
|
|
|
* [package spec](/using-npm/package-spec)
|
|
* [npm publish](/commands/npm-publish)
|
|
* [npm registry](/using-npm/registry)
|
|
* [npm owner](/commands/npm-owner)
|
|
* [npm adduser](/commands/npm-adduser)
|