diff options
Diffstat (limited to 'deps/npm/html/doc/json.html')
| -rw-r--r-- | deps/npm/html/doc/json.html | 48 |
1 files changed, 45 insertions, 3 deletions
diff --git a/deps/npm/html/doc/json.html b/deps/npm/html/doc/json.html index 54e29f8b73..480d684127 100644 --- a/deps/npm/html/doc/json.html +++ b/deps/npm/html/doc/json.html @@ -311,7 +311,7 @@ space-separated descriptors, OR a range like "fromVersion - toVersion"</p> <p>Version range descriptors may be any of the following styles, where "version" is a semver compatible version identifier.</p> -<ul><li><code>version</code> Must match <code>version</code> exactly</li><li><code>=version</code> Same as just <code>version</code></li><li><code>>version</code> Must be greater than <code>version</code></li><li><code>>=version</code> etc</li><li><code><version</code></li><li><code><=version</code></li><li><code>~version</code> See 'Tilde Version Ranges' below</li><li><code>1.2.x</code> See 'X Version Ranges' below</li><li><code>http://...</code> See 'URLs as Dependencies' below</li><li><code>*</code> Matches any version</li><li><code>""</code> (just an empty string) Same as <code>*</code></li><li><code>version1 - version2</code> Same as <code>>=version1 <=version2</code>.</li><li><code>range1 || range2</code> Passes if either range1 or range2 are satisfied.</li></ul> +<ul><li><code>version</code> Must match <code>version</code> exactly</li><li><code>=version</code> Same as just <code>version</code></li><li><code>>version</code> Must be greater than <code>version</code></li><li><code>>=version</code> etc</li><li><code><version</code></li><li><code><=version</code></li><li><code>~version</code> See 'Tilde Version Ranges' below</li><li><code>1.2.x</code> See 'X Version Ranges' below</li><li><code>http://...</code> See 'URLs as Dependencies' below</li><li><code>*</code> Matches any version</li><li><code>""</code> (just an empty string) Same as <code>*</code></li><li><code>version1 - version2</code> Same as <code>>=version1 <=version2</code>.</li><li><code>range1 || range2</code> Passes if either range1 or range2 are satisfied.</li><li><code>git...</code> See 'Git URLs as Dependencies' below</li></ul> <p>For example, these are all valid:</p> @@ -360,6 +360,18 @@ of a version range.</p> <p>This tarball will be downloaded and installed locally to your package at install time.</p> +<h3 id="Git-URLs-as-Dependencies">Git URLs as Dependencies</h3> + +<p>Git urls can be of the form:</p> + +<pre><code>git://github.com/user/project.git#commit-ish +git+ssh://user@hostname:project.git#commit-ish +git+http://user@hostname/project/blah.git#commit-ish +git+https://user@hostname/project/blah.git#commit-ish</code></pre> + +<p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as +an argument to <code>git checkout</code>. The default is <code>master</code>.</p> + <h2 id="devDependencies">devDependencies</h2> <p>If someone is planning on downloading and using your module in their @@ -399,6 +411,36 @@ are capable of properly installing your program. For example:</p> <pre><code>{ "engines" : { "npm" : "~1.0.20" } }</code></pre> +<h2 id="os">os</h2> + +<p>You can specify which operating systems your +module will run on:</p> + +<pre><code>"os" : [ "darwin", "linux" ]</code></pre> + +<p>You can also blacklist instead of whitelist operating systems, +just prepend the blacklisted os with a '!':</p> + +<pre><code>"os" : [ "!win32" ]</code></pre> + +<p>The host operating system is determined by <code>process.platform</code></p> + +<p>It is allowed to both blacklist, and whitelist, although there isn't any +good reason to do this.</p> + +<h2 id="cpu">cpu</h2> + +<p>If your code only runs on certain cpu architectures, +you can specify which ones.</p> + +<pre><code>"cpu" : [ "x64", "ia32" ]</code></pre> + +<p>Like the <code>os</code> option, you can also blacklist architectures:</p> + +<pre><code>"cpu" : [ "!arm", "!mips" ]</code></pre> + +<p>The host architecture is determined by <code>process.arch</code></p> + <h2 id="preferGlobal">preferGlobal</h2> <p>If your package is primarily a command-line application that should be @@ -415,7 +457,7 @@ to publish it.</p> <p>This is a way to prevent accidental publication of private repositories. If you would like to ensure that a given package is only ever published -to a speciic registry (for example, an internal registry), +to a specific registry (for example, an internal registry), then use the <code>publishConfig</code> hash described below to override the <code>registry</code> config param at publish-time.</p> @@ -436,7 +478,7 @@ overridden.</p> <ul><li><a href="../doc/semver.html">semver(1)</a></li><li><a href="../doc/init.html">init(1)</a></li><li><a href="../doc/version.html">version(1)</a></li><li><a href="../doc/config.html">config(1)</a></li><li><a href="../doc/help.html">help(1)</a></li><li><a href="../doc/faq.html">faq(1)</a></li><li><a href="../doc/install.html">install(1)</a></li><li><a href="../doc/publish.html">publish(1)</a></li><li><a href="../doc/rm.html">rm(1)</a></li></ul> </div> -<p id="footer">json — npm@1.1.0-2</p> +<p id="footer">json — npm@1.1.21</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") |