NPM-HELP-SEARCH(3)

💖 NAME 💖

hey bestie, this is npm-help-search(3) — the lil manual page for searching the help pages. yes, that's the whole vibe.

✨ SYNOPSIS ✨

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

🦋 DESCRIPTION 🦋

okay so ngl, this command is rarely useful, but it exists for the rare case where it is useful. it's giving “niche but valid,” and we respect it.

This command takes an array of search terms and returns the help pages that match, in order of best match. lowkey slay.

If there's only one match, then npm displays that help section. If there are multiple results, the results get printed to the screen all formatted, and the array of results is returned. each result is an object with these properties:

• hits — a map of args to the number of hits on that arg. for example, {"npm": 3}
• found — total number of unique args that matched.
• totalHits — total number of hits.
• lines — an array of all matching lines (and some adjacent lines).
• file — name of the file that matched.

the silent parameter is not necessary and not used, but it may be in the future. so like… don't get attached, but also don't be surprised if it wakes up one day with main character energy. 💅

mwah 💋 this page is signed off with the NPM-HELP-SEARCH(3) footer energy, dated March 2017 — vintage, iconic, no cap. 🎀