lukechilds
/
node
mirror of https://github.com/lukechilds/node.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
4954 Commits
131 Branches
446 Tags
325 MiB
 
 
 
 
 
 
Tree: 97900776bb
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '97900776bb'
${ noResults }
node/deps/npm/doc/api/search.md

1.2 KiB
Raw Blame History

npm-search(3) -- Search for packages

SYNOPSIS

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

DESCRIPTION

Search the registry for packages matching the search terms. The available parameters are:

  • searchTerms: Array of search terms. These terms are case-insensitive.

  • silent: If true, npm will not log anything to the console.

  • 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, which 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).