NPM-SHRINKWRAP(3)

🎀 NPM-SHRINKWRAP(3): shrinkwrap, but make it programmatic 🎀

okay so bestie, welcome to the npm-shrinkwrap(3) manual page — this is the one where npm programmatically generates a package shrinkwrap file, and it's giving main character energy, periodt ✨.

💖 NAME 💖

npm-shrinkwrap — programmatically generate package shrinkwrap file 💅

✨ SYNOPSIS ✨

npm.commands.shrinkwrap(args, [silent,] callback)

🌸 DESCRIPTION 🌸

okay so this lowkey acts much the same way as shrinkwrapping on the command-line. Same shrinkwrap vibe, just programmatic, no cap ✨.

Real talk: this command does not take any arguments, but args must be defined. Yes bestie, args is required even though the command itself is not taking positional arguments — the way that works is lowkey iconic 💀.

Beyond that, if any arguments are passed in, npm will politely warn that it does not take positional arguments. Polite but firm, fr fr 🫶.

If the silent parameter is set to true, nothing will be output to the screen, but the shrinkwrap file will still be written. Silent mode = quiet queen, but the file still slays on disk 💅.

Finally, callback is a function that will be called when the shrinkwrap has been saved. It's literally the little "done, bestie" moment of this whole operation 🎀.

bestie reminder: args must be defined, even though the command takes no arguments — that's the whole twist, iykyk 💖

mwah — March 2017, from the NPM-SHRINKWRAP(3) manual page 🌈