diff options
Diffstat (limited to 'deps/npm/html/doc/misc/semver.html')
| -rw-r--r-- | deps/npm/html/doc/misc/semver.html | 37 |
1 files changed, 24 insertions, 13 deletions
diff --git a/deps/npm/html/doc/misc/semver.html b/deps/npm/html/doc/misc/semver.html index a202644c53..28db44aa66 100644 --- a/deps/npm/html/doc/misc/semver.html +++ b/deps/npm/html/doc/misc/semver.html @@ -11,8 +11,7 @@ <h1><a href="../misc/semver.html">semver</a></h1> <p>The semantic versioner for npm</p> <h2 id="install">Install</h2> -<pre><code class="language-bash">npm install --save semver -`</code></pre> +<pre><code class="language-bash">npm install --save semver</code></pre> <h2 id="usage">Usage</h2> <p>As a node module:</p> <pre><code class="language-js">const semver = require('semver') @@ -28,8 +27,6 @@ semver.valid(semver.coerce('42.6.7.9.3-alpha')) // '42.6.7'</cod <p>As a command-line utility:</p> <pre><code>$ semver -h -SemVer 5.3.0 - A JavaScript implementation of the http://semver.org/ specification Copyright Isaac Z. Schlueter @@ -53,6 +50,9 @@ Options: -l --loose Interpret versions and ranges loosely +-p --include-prerelease + Always include prerelease versions in range matching + -c --coerce Coerce a string into SemVer if possible (does not imply --loose) @@ -133,7 +133,7 @@ will append the value of the string as a prerelease identifier:</p> deterministic ways.</p> <p>Advanced ranges may be combined in the same way as primitive comparators using white space or <code>||</code>.</p> -<h4 id="hyphen-ranges-x-y-z-a-b-c">Hyphen Ranges <code>X.Y.Z - A.B.C</code></h4> +<h4 id="hyphen-ranges-xyz---abc">Hyphen Ranges <code>X.Y.Z - A.B.C</code></h4> <p>Specifies an inclusive set.</p> <ul> <li><code>1.2.3 - 2.3.4</code> := <code>>=1.2.3 <=2.3.4</code></li> @@ -151,7 +151,7 @@ provided tuple parts.</p> <li><code>1.2.3 - 2.3</code> := <code>>=1.2.3 <2.4.0</code></li> <li><code>1.2.3 - 2</code> := <code>>=1.2.3 <3.0.0</code></li> </ul> -<h4 id="x-ranges-1-2-x-1-x-1-2-">X-Ranges <code>1.2.x</code> <code>1.X</code> <code>1.2.*</code> <code>*</code></h4> +<h4 id="x-ranges-12x-1x-12-">X-Ranges <code>1.2.x</code> <code>1.X</code> <code>1.2.*</code> <code>*</code></h4> <p>Any of <code>X</code>, <code>x</code>, or <code>*</code> may be used to "stand in" for one of the numeric values in the <code>[major, minor, patch]</code> tuple.</p> <ul> @@ -166,7 +166,7 @@ character is in fact optional.</p> <li><code>1</code> := <code>1.x.x</code> := <code>>=1.0.0 <2.0.0</code></li> <li><code>1.2</code> := <code>1.2.x</code> := <code>>=1.2.0 <1.3.0</code></li> </ul> -<h4 id="tilde-ranges-1-2-3-1-2-1">Tilde Ranges <code>~1.2.3</code> <code>~1.2</code> <code>~1</code></h4> +<h4 id="tilde-ranges-123-12-1">Tilde Ranges <code>~1.2.3</code> <code>~1.2</code> <code>~1</code></h4> <p>Allows patch-level changes if a minor version is specified on the comparator. Allows minor-level changes if not.</p> <ul> @@ -182,7 +182,7 @@ equal to <code>beta.2</code>. So, <code>1.2.3-beta.4</code> would be allowed, b <code>1.2.4-beta.2</code> would not, because it is a prerelease of a different <code>[major, minor, patch]</code> tuple.</li> </ul> -<h4 id="caret-ranges-1-2-3-0-2-5-0-0-4">Caret Ranges <code>^1.2.3</code> <code>^0.2.5</code> <code>^0.0.4</code></h4> +<h4 id="caret-ranges-123-025-004">Caret Ranges <code>^1.2.3</code> <code>^0.2.5</code> <code>^0.0.4</code></h4> <p>Allows changes that do not modify the left-most non-zero digit in the <code>[major, minor, patch]</code> tuple. In other words, this allows patch and minor updates for versions <code>1.0.0</code> and above, patch updates for @@ -242,9 +242,20 @@ build ::= parts parts ::= part ( '.' part ) * part ::= nr | [-0-9A-Za-z]+</code></pre> <h2 id="functions">Functions</h2> -<p>All methods and classes take a final <code>loose</code> boolean argument that, if -true, will be more forgiving about not-quite-valid semver strings. -The resulting output will always be 100% strict, of course.</p> +<p>All methods and classes take a final <code>options</code> object argument. All +options in this object are <code>false</code> by default. The options supported +are:</p> +<ul> +<li><code>loose</code> Be more forgiving about not-quite-valid semver strings. +(Any resulting output will always be 100% strict compliant, of +course.) For backwards compatibility reasons, if the <code>options</code> +argument is a boolean value instead of an object, it is interpreted +to be the <code>loose</code> param.</li> +<li><code>includePrerelease</code> Set to suppress the <a href="https://github.com/npm/node-semver#prerelease-tags">default +behavior</a> of +excluding prerelease tagged versions from ranges unless they are +explicitly opted into.</li> +</ul> <p>Strict-mode Comparators and Ranges will be strict about the SemVer strings that they parse.</p> <ul> @@ -295,7 +306,7 @@ or null if the versions are the same.</li> <ul> <li><code>intersects(comparator)</code>: Return true if the comparators intersect</li> </ul> -<h3 id="ranges">Ranges</h3> +<h3 id="ranges-1">Ranges</h3> <ul> <li><code>validRange(range)</code>: Return the valid range or null if it's not valid</li> <li><code>satisfies(version, range)</code>: Return true if the version satisfies the @@ -350,5 +361,5 @@ higher value components are invalid (<code>9999999999999999.4.7.4</code> is like <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">semver — npm@6.5.0</p> +<p id="footer">semver — npm@6.7.0</p> |