npm: Upgrade to 1.3.19
[platform/upstream/nodejs.git] / deps / npm / html / doc / api / npm-explore.html
1 <!doctype html>
2 <html>
3   <title>npm-explore</title>
4   <meta http-equiv="content-type" value="text/html;utf-8">
5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
6
7   <body>
8     <div id="wrapper">
9 <h1><a href="../api/npm-explore.html">npm-explore</a></h1> <p>Browse an installed package</p>
10
11 <h2 id="SYNOPSIS">SYNOPSIS</h2>
12
13 <pre><code>npm.commands.explore(args, callback)</code></pre>
14
15 <h2 id="DESCRIPTION">DESCRIPTION</h2>
16
17 <p>Spawn a subshell in the directory of the installed package specified.</p>
18
19 <p>If a command is specified, then it is run in the subshell, which then
20 immediately terminates.</p>
21
22 <p>Note that the package is <em>not</em> automatically rebuilt afterwards, so be
23 sure to use <code>npm rebuild &lt;pkg&gt;</code> if you make any changes.</p>
24
25 <p>The first element in the &#39;args&#39; parameter must be a package name.  After that is the optional command, which can be any number of strings. All of the strings will be combined into one, space-delimited command.</p>
26 </div>
27 <p id="footer">npm-explore &mdash; npm@1.3.19</p>
28 <script>
29 ;(function () {
30 var wrapper = document.getElementById("wrapper")
31 var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
32   .filter(function (el) {
33     return el.parentNode === wrapper
34         && el.tagName.match(/H[1-6]/)
35         && el.id
36   })
37 var l = 2
38   , toc = document.createElement("ul")
39 toc.innerHTML = els.map(function (el) {
40   var i = el.tagName.charAt(1)
41     , out = ""
42   while (i > l) {
43     out += "<ul>"
44     l ++
45   }
46   while (i < l) {
47     out += "</ul>"
48     l --
49   }
50   out += "<li><a href='#" + el.id + "'>" +
51     ( el.innerText || el.text || el.innerHTML)
52     + "</a>"
53   return out
54 }).join("\n")
55 toc.id = "toc"
56 document.body.appendChild(toc)
57 })()
58 </script>