Versions are printed in ascending order, so supplying
multiple versions to the utility will just sort them.
</code></pre><h2 id="versions">Versions</h2>
-<p>A "version" is described by the v2.0.0 specification found at
+<p>A "version" is described by the <code>v2.0.0</code> specification found at
<a href="http://semver.org/">http://semver.org/</a>.</p>
<p>A leading <code>"="</code> or <code>"v"</code> character is stripped off and ignored.</p>
<h2 id="ranges">Ranges</h2>
<p>The following range styles are supported:</p>
<ul>
-<li><code>1.2.3</code> A specific version. When nothing else will do. Note that
-build metadata is still ignored, so <code>1.2.3+build2012</code> will satisfy
-this range.</li>
+<li><code>1.2.3</code> A specific version. When nothing else will do. Must be a full
+version number, with major, minor, and patch versions specified.
+Note that build metadata is still ignored, so <code>1.2.3+build2012</code> will
+satisfy this range.</li>
<li><code>>1.2.3</code> Greater than a specific version.</li>
<li><code><1.2.3</code> Less than a specific version. If there is no prerelease
tag on the version range, then no prerelease version will be allowed
<li><code><=1.2.3</code> Less than or equal to. In this case, prerelease versions
ARE allowed, so <code>1.2.3-beta</code> would satisfy.</li>
<li><code>1.2.3 - 2.3.4</code> := <code>>=1.2.3 <=2.3.4</code></li>
-<li><code>~1.2.3</code> := <code>>=1.2.3-0 <1.3.0-0</code> "Reasonably close to 1.2.3". When
+<li><code>~1.2.3</code> := <code>>=1.2.3-0 <1.3.0-0</code> "Reasonably close to <code>1.2.3</code>". When
using tilde operators, prerelease versions are supported as well,
but a prerelease of the next significant digit will NOT be
satisfactory, so <code>1.3.0-beta</code> will not satisfy <code>~1.2.3</code>.</li>
-<li><code>^1.2.3</code> := <code>>=1.2.3-0 <2.0.0-0</code> "Compatible with 1.2.3". When
+<li><code>^1.2.3</code> := <code>>=1.2.3-0 <2.0.0-0</code> "Compatible with <code>1.2.3</code>". When
using caret operators, anything from the specified version (including
prerelease) will be supported up to, but not including, the next
major version (or its prereleases). <code>1.5.1</code> will satisfy <code>^1.2.3</code>,
while <code>1.2.2</code> and <code>2.0.0-beta</code> will not.</li>
-<li><code>^0.1.3</code> := <code>>=0.1.3-0 <0.2.0-0</code> "Compatible with 0.1.3". 0.x.x versions are
+<li><code>^0.1.3</code> := <code>>=0.1.3-0 <0.2.0-0</code> "Compatible with <code>0.1.3</code>". <code>0.x.x</code> versions are
special: the first non-zero component indicates potentially breaking changes,
meaning the caret operator matches any version with the same first non-zero
component starting at the specified version.</li>
-<li><code>^0.0.2</code> := <code>=0.0.2</code> "Only the version 0.0.2 is considered compatible"</li>
-<li><code>~1.2</code> := <code>>=1.2.0-0 <1.3.0-0</code> "Any version starting with 1.2"</li>
-<li><code>^1.2</code> := <code>>=1.2.0-0 <2.0.0-0</code> "Any version compatible with 1.2"</li>
-<li><code>1.2.x</code> := <code>>=1.2.0-0 <1.3.0-0</code> "Any version starting with 1.2"</li>
-<li><code>~1</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version starting with 1"</li>
-<li><code>^1</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version compatible with 1"</li>
-<li><code>1.x</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version starting with 1"</li>
+<li><code>^0.0.2</code> := <code>=0.0.2</code> "Only the version <code>0.0.2</code> is considered compatible"</li>
+<li><code>~1.2</code> := <code>>=1.2.0-0 <1.3.0-0</code> "Any version starting with <code>1.2</code>"</li>
+<li><code>^1.2</code> := <code>>=1.2.0-0 <2.0.0-0</code> "Any version compatible with <code>1.2</code>"</li>
+<li><code>1.2.x</code> := <code>>=1.2.0-0 <1.3.0-0</code> "Any version starting with <code>1.2</code>"</li>
+<li><code>1.2.*</code> Same as <code>1.2.x</code>.</li>
+<li><code>1.2</code> Same as <code>1.2.x</code>.</li>
+<li><code>~1</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version starting with <code>1</code>"</li>
+<li><code>^1</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version compatible with <code>1</code>"</li>
+<li><code>1.x</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version starting with <code>1</code>"</li>
+<li><code>1.*</code> Same as <code>1.x</code>.</li>
+<li><code>1</code> Same as <code>1.x</code>.</li>
+<li><code>*</code> Any version whatsoever.</li>
+<li><code>x</code> Same as <code>*</code>.</li>
+<li><code>""</code> (just an empty string) Same as <code>*</code>.</li>
</ul>
<p>Ranges can be joined with either a space (which implies "and") or a
<code>||</code> (which implies "or").</p>
<p>Strict-mode Comparators and Ranges will be strict about the SemVer
strings that they parse.</p>
<ul>
-<li>valid(v): Return the parsed version, or null if it's not valid.</li>
-<li>inc(v, release): Return the version incremented by the release type
-(major, minor, patch, or prerelease), or null if it's not valid.</li>
+<li><code>valid(v)</code>: Return the parsed version, or null if it's not valid.</li>
+<li><code>inc(v, release)</code>: Return the version incremented by the release
+type (<code>major</code>, <code>premajor</code>, <code>minor</code>, <code>preminor</code>, <code>patch</code>,
+<code>prepatch</code>, or <code>prerelease</code>), or null if it's not valid<ul>
+<li><code>premajor</code> in one call will bump the version up to the next major
+version and down to a prerelease of that major version.
+<code>preminor</code>, and <code>prepatch</code> work the same way.</li>
+<li>If called from a non-prerelease version, the <code>prerelease</code> will work the
+same as <code>prepatch</code>. It increments the patch version, then makes a
+prerelease. If the input version is already a prerelease it simply
+increments it.</li>
+</ul>
+</li>
</ul>
<h3 id="comparison">Comparison</h3>
<ul>
-<li>gt(v1, v2): <code>v1 > v2</code></li>
-<li>gte(v1, v2): <code>v1 >= v2</code></li>
-<li>lt(v1, v2): <code>v1 < v2</code></li>
-<li>lte(v1, v2): <code>v1 <= v2</code></li>
-<li>eq(v1, v2): <code>v1 == v2</code> This is true if they're logically equivalent,
+<li><code>gt(v1, v2)</code>: <code>v1 > v2</code></li>
+<li><code>gte(v1, v2)</code>: <code>v1 >= v2</code></li>
+<li><code>lt(v1, v2)</code>: <code>v1 < v2</code></li>
+<li><code>lte(v1, v2)</code>: <code>v1 <= v2</code></li>
+<li><code>eq(v1, v2)</code>: <code>v1 == v2</code> This is true if they're logically equivalent,
even if they're not the exact same string. You already know how to
compare strings.</li>
-<li>neq(v1, v2): <code>v1 != v2</code> The opposite of eq.</li>
-<li>cmp(v1, comparator, v2): Pass in a comparison string, and it'll call
+<li><code>neq(v1, v2)</code>: <code>v1 != v2</code> The opposite of <code>eq</code>.</li>
+<li><code>cmp(v1, comparator, v2)</code>: Pass in a comparison string, and it'll call
the corresponding function above. <code>"==="</code> and <code>"!=="</code> do simple
string comparison, but are included for completeness. Throws if an
invalid comparison string is provided.</li>
-<li>compare(v1, v2): Return 0 if v1 == v2, or 1 if v1 is greater, or -1 if
-v2 is greater. Sorts in ascending order if passed to Array.sort().</li>
-<li>rcompare(v1, v2): The reverse of compare. Sorts an array of versions
-in descending order when passed to Array.sort().</li>
+<li><code>compare(v1, v2)</code>: Return <code>0</code> if <code>v1 == v2</code>, or <code>1</code> if <code>v1</code> is greater, or <code>-1</code> if
+<code>v2</code> is greater. Sorts in ascending order if passed to <code>Array.sort()</code>.</li>
+<li><code>rcompare(v1, v2)</code>: The reverse of compare. Sorts an array of versions
+in descending order when passed to <code>Array.sort()</code>.</li>
</ul>
<h3 id="ranges">Ranges</h3>
<ul>
-<li>validRange(range): Return the valid range or null if it's not valid</li>
-<li>satisfies(version, range): Return true if the version satisfies the
+<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
range.</li>
-<li>maxSatisfying(versions, range): Return the highest version in the list
-that satisfies the range, or null if none of them do.</li>
-<li>gtr(version, range): Return true if version is greater than all the
+<li><code>maxSatisfying(versions, range)</code>: Return the highest version in the list
+that satisfies the range, or <code>null</code> if none of them do.</li>
+<li><code>gtr(version, range)</code>: Return <code>true</code> if version is greater than all the
versions possible in the range.</li>
-<li>ltr(version, range): Return true if version is less than all the
+<li><code>ltr(version, range)</code>: Return <code>true</code> if version is less than all the
versions possible in the range.</li>
-<li>outside(version, range, hilo): Return true if the version is outside
+<li><code>outside(version, range, hilo)</code>: Return true if the version is outside
the bounds of the range in either the high or low direction. The
<code>hilo</code> argument must be either the string <code>'>'</code> or <code>'<'</code>. (This is
the function called by <code>gtr</code> and <code>ltr</code>.)</li>
greater than a range, less than a range, <em>or</em> satisfy a range! For
example, the range <code>1.2 <1.2.9 || >2.0.0</code> would have a hole from <code>1.2.9</code>
until <code>2.0.0</code>, so the version <code>1.2.10</code> would not be greater than the
-range (because 2.0.1 satisfies, which is higher), nor less than the
-range (since 1.2.8 satisfies, which is lower), and it also does not
+range (because <code>2.0.1</code> satisfies, which is higher), nor less than the
+range (since <code>1.2.8</code> satisfies, which is lower), and it also does not
satisfy the range.</p>
<p>If you want to know if a version satisfies or does not satisfy a
range, use the <code>satisfies(version, range)</code> function.</p>
<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@1.4.10</p>
+<p id="footer">semver — npm@1.4.14</p>
projects / platform / upstream / nodejs.git / blobdiff