node/deps/npm/man/man3/search.3
isaacs 054127112c Upgrade npm to 1.1.3
* Update request to support HTTPS-over-HTTP proxy tunneling
* Throw on undefined envs in config settings
* Update which to 1.0.5
* Fix windows UNC busyloop in findPrefix
* Bundle nested bundleDependencies properly
* Alias adduser to add-user
* Doc updates  (Christian Howe, Henrik Hodne, Andrew Lunny)
* ignore logfd/outfd streams in makeEnv() (Rod Vagg)
* shrinkwrap: Behave properly with url-installed deps
* install: Support --save with url install targets
* Support installing naked tars or single-file modules from urls etc.
* init: Don't add engines section
* Don't run make clean on rebuild
* Added missing unicode replacement (atomizer)
2012-03-02 09:31:46 -08:00

65 lines
1.5 KiB
Groff

.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-SEARCH" "3" "March 2012" "" ""
.
.SH "NAME"
\fBnpm-search\fR \-\- Search for packages
.
.SH "SYNOPSIS"
.
.nf
npm\.commands\.search(searchTerms, [silent,] [staleness,] callback)
.
.fi
.
.SH "DESCRIPTION"
Search the registry for packages matching the search terms\. The available parameters are:
.
.IP "\(bu" 4
searchTerms:
Array of search terms\. These terms are case\-insensitive\.
.
.IP "\(bu" 4
silent:
If true, npm will not log anything to the console\.
.
.IP "\(bu" 4
staleness:
This is the threshold for stale packages\. "Fresh" packages are not refreshed
from the registry\. This value is measured in seconds\.
.
.IP "\(bu" 4
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:
.
.IP "\(bu" 4
name
.
.IP "\(bu" 4
description
.
.IP "\(bu" 4
maintainers
.
.IP "\(bu" 4
url
.
.IP "\(bu" 4
keywords
.
.IP "" 0
.
.IP "" 0
.
.P
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)\.