← Back to branch summary

~webapps/unity-js-scopes/node.js

« back to all changes in this revision

Viewing changes to deps/npm/html/doc/api/npm-search.html

  • Committer: Marcus Tomlinson
  • Date: 2015-11-13 07:59:04 UTC
  • Revision ID: marcus.tomlinson@canonical.com-20151113075904-h0swczmoq1rvstfc
Node v4 (stable)

Show diffs side-by-side

added added

removed removed

Lines of Context:
deps/npm/html/doc/api/npm-search.html
 
1
<!doctype html>
 
2
<html>
 
3
  <title>npm-search</title>
 
4
  <meta http-equiv="content-type" value="text/html;utf-8">
 
5
  <link rel="stylesheet" type="text/css" href="../../static/style.css">
 
6
  <link rel="canonical" href="https://www.npmjs.org/doc/api/npm-search.html">
 
7
  <script async=true src="../../static/toc.js"></script>
 
8
 
 
9
  <body>
 
10
    <div id="wrapper">
 
11
 
 
12
<h1><a href="../api/npm-search.html">npm-search</a></h1> <p>Search for packages</p>
 
13
<h2 id="synopsis">SYNOPSIS</h2>
 
14
<pre><code>npm.commands.search(searchTerms, [silent,] [staleness,] callback)
 
15
</code></pre><h2 id="description">DESCRIPTION</h2>
 
16
<p>Search the registry for packages matching the search terms. The available parameters are:</p>
 
17
<ul>
 
18
<li>searchTerms:
 
19
Array of search terms. These terms are case-insensitive.</li>
 
20
<li>silent:
 
21
If true, npm will not log anything to the console.</li>
 
22
<li>staleness:
 
23
This is the threshold for stale packages. &quot;Fresh&quot; packages are not refreshed
 
24
from the registry. This value is measured in seconds.</li>
 
25
<li><p>callback:
 
26
Returns an object where each key is the name of a package, and the value
 
27
is information about that package along with a &#39;words&#39; property, which is
 
28
a space-delimited string of all of the interesting words in that package.
 
29
The only properties included are those that are searched, which generally include:</p>
 
30
<ul>
 
31
<li>name</li>
 
32
<li>description</li>
 
33
<li>maintainers</li>
 
34
<li>url</li>
 
35
<li>keywords</li>
 
36
</ul>
 
37
</li>
 
38
</ul>
 
39
<p>A search on the registry excludes any result that does not match all of the
 
40
search terms. It also removes any items from the results that contain an
 
41
excluded term (the &quot;searchexclude&quot; config). The search is case insensitive
 
42
and doesn&#39;t try to read your mind (it doesn&#39;t do any verb tense matching or the
 
43
like).</p>
 
44
 
 
45
</div>
 
46
 
 
47
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
 
48
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
 
49
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td colspan=6 style="width:60px;height:10px;background:#fff">&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td></tr>
 
50
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2>&nbsp;</td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td></tr>
 
51
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
 
52
<tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
 
53
<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6>&nbsp;</td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td></tr>
 
54
<tr><td colspan=5 style="width:50px;height:10px;background:#fff">&nbsp;</td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4>&nbsp;</td><td style="width:90px;height:10px;background:#fff" colspan=9>&nbsp;</td></tr>
 
55
</table>
 
56
<p id="footer">npm-search &mdash; npm@2.14.2</p>
 
57