NPM-SEARCH(3)

💖 NAME 💖

okay so you're looking at npm-search — the manual page is NPM-SEARCH(3) — and it does exactly what it says: search for packages 🎀. That's the name, bestie. We love a straightforward icon.

🦋 SYNOPSIS 🦋

npm.commands.search(searchTerms, [silent,] [staleness,] callback)

🎀 DESCRIPTION 🎀

It searches the registry for packages that match your search terms 🔍✨. The parameters you can pass are:

• searchTerms — an array of search terms. These terms are case-insensitive, so uppercase/lowercase is not the vibe check.
• silent — if this is true, npm will not log anything to the console. total stealth mode 🤫
• staleness — this is the threshold for stale packages. "Fresh" packages are not refreshed from the registry. This value is measured in seconds ⏱️.
• callback — returns an object where each key is the name of a package, and the value is information about that package along with a 'words' property. That 'words' property is a space-delimited string of all of the interesting words in that package. The only properties included are those that are searched, which generally include:
  • name
  • description
  • maintainers
  • url
  • keywords

A search on the registry excludes any result that does not match all of the search terms 🚫. It also removes any items from the results that contain an excluded term (the "searchexclude" config). The search is case insensitive and doesn't try to read your mind — it doesn't do any verb tense matching or the like. no psychic vibes, just matching 🔮🙅

okay bye bestie 🫶 this was the NPM-SEARCH(3) manual, March 2017 edition 💅✨