| <!doctype html> |
| <html> |
| <title>npm-help-search</title> |
| <meta http-equiv="content-type" value="text/html;utf-8"> |
| <link rel="stylesheet" type="text/css" href="../../static/style.css"> |
| <link rel="canonical" href="https://www.npmjs.org/doc/api/npm-help-search.html"> |
| <script async=true src="../../static/toc.js"></script> |
| |
| <body> |
| <div id="wrapper"> |
| |
| <h1><a href="../api/npm-help-search.html">npm-help-search</a></h1> <p>Search the help pages</p> |
| <h2 id="synopsis">SYNOPSIS</h2> |
| <pre><code>npm.commands.helpSearch(args, [silent,] callback) |
| </code></pre><h2 id="description">DESCRIPTION</h2> |
| <p>This command is rarely useful, but it exists in the rare case that it is.</p> |
| <p>This command takes an array of search terms and returns the help pages that |
| match in order of best match.</p> |
| <p>If there is only one match, then npm displays that help section. If there |
| are multiple results, the results are printed to the screen formatted and the |
| array of results is returned. Each result is an object with these properties:</p> |
| <ul> |
| <li>hits: |
| A map of args to number of hits on that arg. For example, {"npm": 3}</li> |
| <li>found: |
| Total number of unique args that matched.</li> |
| <li>totalHits: |
| Total number of hits.</li> |
| <li>lines: |
| An array of all matching lines (and some adjacent lines).</li> |
| <li>file: |
| Name of the file that matched</li> |
| </ul> |
| <p>The silent parameter is not necessary not used, but it may in the future.</p> |
| |
| </div> |
| |
| <table border=0 cellspacing=0 cellpadding=0 id=npmlogo> |
| <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr> |
| <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr> |
| <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr> |
| <tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr> |
| <tr><td style="width:10px;height:10px;background:#fff"> </td></tr> |
| <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> |
| <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> |
| </table> |
| <p id="footer">npm-help-search — npm@2.15.8</p> |
| |