diff options
Diffstat (limited to 'deps/npm/html/api/view.html')
| -rw-r--r-- | deps/npm/html/api/view.html | 134 |
1 files changed, 0 insertions, 134 deletions
diff --git a/deps/npm/html/api/view.html b/deps/npm/html/api/view.html deleted file mode 100644 index c18677182..000000000 --- a/deps/npm/html/api/view.html +++ /dev/null @@ -1,134 +0,0 @@ -<!doctype html> -<html> - <title>view</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/view.html">view</a></h1> <p>View registry info</p> - -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<pre><code>npm.commands.view(args, [silent,] callback)</code></pre> - -<h2 id="DESCRIPTION">DESCRIPTION</h2> - -<p>This command shows data about a package and prints it to the stream -referenced by the <code>outfd</code> config, which defaults to stdout.</p> - -<p>The "args" parameter is an ordered list that closely resembles the command-line -usage. The elements should be ordered such that the first element is -the package and version (package@version). The version is optional. After that, -the rest of the parameters are fields with optional subfields ("field.subfield") -which can be used to get only the information desired from the registry.</p> - -<p>The callback will be passed all of the data returned by the query.</p> - -<p>For example, to get the package registry entry for the <code>connect</code> package, -you can do this:</p> - -<pre><code>npm.commands.view(["connect"], callback)</code></pre> - -<p>If no version is specified, "latest" is assumed.</p> - -<p>Field names can be specified after the package descriptor. -For example, to show the dependencies of the <code>ronn</code> package at version -0.3.5, you could do the following:</p> - -<pre><code>npm.commands.view(["ronn@0.3.5", "dependencies"], callback)</code></pre> - -<p>You can view child field by separating them with a period. -To view the git repository URL for the latest version of npm, you could -do this:</p> - -<pre><code>npm.commands.view(["npm", "repository.url"], callback)</code></pre> - -<p>For fields that are arrays, requesting a non-numeric field will return -all of the values from the objects in the list. For example, to get all -the contributor names for the "express" project, you can do this:</p> - -<pre><code>npm.commands.view(["express", "contributors.email"], callback)</code></pre> - -<p>You may also use numeric indices in square braces to specifically select -an item in an array field. To just get the email address of the first -contributor in the list, you can do this:</p> - -<pre><code>npm.commands.view(["express", "contributors[0].email"], callback)</code></pre> - -<p>Multiple fields may be specified, and will be printed one after another. -For exampls, to get all the contributor names and email addresses, you -can do this:</p> - -<pre><code>npm.commands.view(["express", "contributors.name", "contributors.email"], callback)</code></pre> - -<p>"Person" fields are shown as a string if they would be shown as an -object. So, for example, this will show the list of npm contributors in -the shortened string format. (See <code>npm help json</code> for more on this.)</p> - -<pre><code>npm.commands.view(["npm", "contributors"], callback)</code></pre> - -<p>If a version range is provided, then data will be printed for every -matching version of the package. This will show which version of jsdom -was required by each matching version of yui3:</p> - -<pre><code>npm.commands.view(["yui3@'>0.5.4'", "dependencies.jsdom"], callback)</code></pre> - -<h2 id="OUTPUT">OUTPUT</h2> - -<p>If only a single string field for a single version is output, then it -will not be colorized or quoted, so as to enable piping the output to -another command.</p> - -<p>If the version range matches multiple versions, than each printed value -will be prefixed with the version it applies to.</p> - -<p>If multiple fields are requested, than each of them are prefixed with -the field name.</p> - -<p>Console output can be disabled by setting the 'silent' parameter to true.</p> - -<h2 id="RETURN-VALUE">RETURN VALUE</h2> - -<p>The data returned will be an object in this formation:</p> - -<pre><code>{ <version>: - { <field>: <value> - , ... } -, ... }</code></pre> - -<p>corresponding to the list of fields selected.</p> -</div> -<p id="footer">view — npm@1.2.30</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> -</body></html> |