org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/man/man3/npm-search.3

   1 .TH "NPM\-SEARCH" "3" "October 2016" "" ""
   2 .SH "NAME"
   3 \fBnpm-search\fR \- Search for packages
   4 .SH SYNOPSIS
   5 .P
   6 .RS 2
   7 .nf
   8 npm\.commands\.search(searchTerms, [silent,] [staleness,] callback)
   9 .fi
  10 .RE
  11 .SH DESCRIPTION
  12 .P
  13 Search the registry for packages matching the search terms\. The available parameters are:
  14 .RS 0
  15 .IP \(bu 2
  16 searchTerms:
  17 Array of search terms\. These terms are case\-insensitive\.
  18 .IP \(bu 2
  19 silent:
  20 If true, npm will not log anything to the console\.
  21 .IP \(bu 2
  22 staleness:
  23 This is the threshold for stale packages\. "Fresh" packages are not refreshed
  24 from the registry\. This value is measured in seconds\.
  25 .IP \(bu 2
  26 callback:
  27 Returns an object where each key is the name of a package, and the value
  28 is information about that package along with a 'words' property, which is
  29 a space\-delimited string of all of the interesting words in that package\.
  30 The only properties included are those that are searched, which generally include:
  31 .RS 0
  32 .IP \(bu 2
  33 name
  34 .IP \(bu 2
  35 description
  36 .IP \(bu 2
  37 maintainers
  38 .IP \(bu 2
  39 url
  40 .IP \(bu 2
  41 keywords
  42
  43 .RE
  44
  45 .RE
  46 .P
  47 A search on the registry excludes any result that does not match all of the
  48 search terms\. It also removes any items from the results that contain an
  49 excluded term (the "searchexclude" config)\. The search is case insensitive
  50 and doesn't try to read your mind (it doesn't do any verb tense matching or the
  51 like)\.
  52