NPM-DOCS(3)

🦋 NAME 🦋

npm-docs — docs for a package in a web browser maybe.

Okay so real talk: this is the NPM-DOCS(3) manual page, and yes, the “maybe” is part of the title. iykyk. 💅

✨ SYNOPSIS ✨

npm.commands.docs(package, callback)

💅 DESCRIPTION 💅

okay bestie, here’s the vibe. This command tries to guess at the likely location of a package’s documentation URL, and then it tries to open that URL using the --browser config param. Like, it is out here doing detective work for docs. 🔥

Like other commands, the first parameter is an array. This command only uses the first element, which is expected to be a package name with an optional version number. So don’t overthink the array, bestie — only the first one is getting the spotlight. 👑

no cap: this command will launch a browser, so it may not be the most friendly for programmatic use. Like, it’s giving “for human besties, not your robot script” energy. 😭

💖 kisses and slay, bestie — this iconic little page is from the NPM-DOCS(3) manual, dated March 2017. periodt. 💖