| <!doctype html> |
| <html> |
| <title>npm-search</title> |
| <meta http-equiv="content-type" value="text/html;utf-8"> |
| <link rel="stylesheet" type="text/css" href="../../static/style.css"> |
| |
| <body> |
| <div id="wrapper"> |
| <h1><a href="../api/npm-search.html">npm-search</a></h1> <p>Search for packages</p> |
| |
| <h2 id="SYNOPSIS">SYNOPSIS</h2> |
| |
| <pre><code>npm.commands.search(searchTerms, [silent,] [staleness,] callback)</code></pre> |
| |
| <h2 id="DESCRIPTION">DESCRIPTION</h2> |
| |
| <p>Search the registry for packages matching the search terms. The available parameters are:</p> |
| |
| <ul><li>searchTerms: |
| Array of search terms. These terms are case-insensitive.</li><li>silent: |
| If true, npm will not log anything to the console.</li><li>staleness: |
| This is the threshold for stale packages. "Fresh" packages are not refreshed |
| from the registry. This value is measured in seconds.</li><li><p>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:</p><ul><li>name</li><li>description</li><li>maintainers</li><li>url</li><li>keywords</li></ul></li></ul> |
| |
| <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).</p> |
| </div> |
| <p id="footer">npm-search — npm@1.3.21</p> |
| <script> |
| ;(function () { |
| var wrapper = document.getElementById("wrapper") |
| var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0) |
| .filter(function (el) { |
| return el.parentNode === wrapper |
| && el.tagName.match(/H[1-6]/) |
| && el.id |
| }) |
| var l = 2 |
| , toc = document.createElement("ul") |
| toc.innerHTML = els.map(function (el) { |
| var i = el.tagName.charAt(1) |
| , out = "" |
| while (i > l) { |
| out += "<ul>" |
| l ++ |
| } |
| while (i < l) { |
| out += "</ul>" |
| l -- |
| } |
| out += "<li><a href='#" + el.id + "'>" + |
| ( el.innerText || el.text || el.innerHTML) |
| + "</a>" |
| return out |
| }).join("\n") |
| toc.id = "toc" |
| document.body.appendChild(toc) |
| })() |
| </script> |
