NPM-DEPRECATE(3)

💅 npm-deprecate(3) — NPM manual glow-up 💅

okay so bestie, this is the manual page for npm-deprecate, and it is lowkey iconic: it's the thing that updates a package's npm registry entry with a deprecation warning so everyone who tries to install it gets the heads-up. no cap. ✨

🌸 NAME 🌸

npm-deprecate — deprecate a version of a package. periodt. 💖

🎀 SYNOPSIS 🎀

npm.commands.deprecate(args, callback)

✨ DESCRIPTION ✨

This command will update the npm registry entry for a package, providing a deprecation warning to all who attempt to install it. it's giving "hey bestie maybe don't install this one" energy, fr. 👑

The args parameter must have exactly two elements — like, exactly two, bestie, do not try to sneak in a third:

• package[@version] — the version portion is optional, and may be either a range, or a specific version, or a tag. so you can point at an exact version, a range, or a tag. slay. 🎀
• message — the warning message that will be printed whenever a user attempts to install the package. make it clear, make it useful, make it a warning. 💅

ngl, you must be the package owner to deprecate something. see the owner and adduser help topics. iykyk. 🔑

To un-deprecate a package, specify an empty string ("") for the message argument. yup — just the empty string, that's the un-deprecate move. 💖

💖 SEE ALSO 💖

• npm apihelp publish
• npm apihelp unpublish
• npm help 7 registry

mwah 💋 this page is NPM-DEPRECATE(3), from the NPM manual, dated March 2017 — iconic, fr fr. bye bestie 🫶