deps/npm/html/doc/misc/semver.html

   1 <!doctype html>
   2 <html>
   3   <title>semver</title>
   4   <meta http-equiv="content-type" value="text/html;utf-8">
   5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
   6   <link rel="canonical" href="https://www.npmjs.org/doc/misc/semver.html">
   7   <script async=true src="../../static/toc.js"></script>
   8
   9   <body>
  10     <div id="wrapper">
  11
  12 <h1><a href="../misc/semver.html">semver</a></h1> <p>The semantic versioner for npm</p>
  13
  14 <h2 id="Usage">Usage</h2>
  15
  16 <pre><code>$ npm install semver
  17
  18 semver.valid(&#39;1.2.3&#39;) // &#39;1.2.3&#39;
  19 semver.valid(&#39;a.b.c&#39;) // null
  20 semver.clean(&#39;  =v1.2.3   &#39;) // &#39;1.2.3&#39;
  21 semver.satisfies(&#39;1.2.3&#39;, &#39;1.x || &gt;=2.5.0 || 5.0.0 - 7.2.3&#39;) // true
  22 semver.gt(&#39;1.2.3&#39;, &#39;9.8.7&#39;) // false
  23 semver.lt(&#39;1.2.3&#39;, &#39;9.8.7&#39;) // true</code></pre>
  24
  25 <p>As a command-line utility:</p>
  26
  27 <pre><code>$ semver -h
  28
  29 Usage: semver &lt;version&gt; [&lt;version&gt; [...]] [-r &lt;range&gt; | -i &lt;inc&gt; | -d &lt;dec&gt;]
  30 Test if version(s) satisfy the supplied range(s), and sort them.
  31
  32 Multiple versions or ranges may be supplied, unless increment
  33 or decrement options are specified.  In that case, only a single
  34 version may be used, and it is incremented by the specified level
  35
  36 Program exits successfully if any valid version satisfies
  37 all supplied ranges, and prints all satisfying versions.
  38
  39 If no versions are valid, or ranges are not satisfied,
  40 then exits failure.
  41
  42 Versions are printed in ascending order, so supplying
  43 multiple versions to the utility will just sort them.</code></pre>
  44
  45 <h2 id="Versions">Versions</h2>
  46
  47 <p>A &quot;version&quot; is described by the v2.0.0 specification found at
  48 <a href="http://semver.org/">http://semver.org/</a>.</p>
  49
  50 <p>A leading <code>&quot;=&quot;</code> or <code>&quot;v&quot;</code> character is stripped off and ignored.</p>
  51
  52 <h2 id="Ranges">Ranges</h2>
  53
  54 <p>The following range styles are supported:</p>
  55
  56 <ul><li><code>1.2.3</code> A specific version.  When nothing else will do.  Note that
  57 build metadata is still ignored, so <code>1.2.3+build2012</code> will satisfy
  58 this range.</li><li><code>&gt;1.2.3</code> Greater than a specific version.</li><li><code>&lt;1.2.3</code> Less than a specific version.  If there is no prerelease
  59 tag on the version range, then no prerelease version will be allowed
  60 either, even though these are technically &quot;less than&quot;.</li><li><code>&gt;=1.2.3</code> Greater than or equal to.  Note that prerelease versions
  61 are NOT equal to their &quot;normal&quot; equivalents, so <code>1.2.3-beta</code> will
  62 not satisfy this range, but <code>2.3.0-beta</code> will.</li><li><code>&lt;=1.2.3</code> Less than or equal to.  In this case, prerelease versions
  63 ARE allowed, so <code>1.2.3-beta</code> would satisfy.</li><li><code>1.2.3 - 2.3.4</code> := <code>&gt;=1.2.3 &lt;=2.3.4</code></li><li><code>~1.2.3</code> := <code>&gt;=1.2.3-0 &lt;1.3.0-0</code>  &quot;Reasonably close to 1.2.3&quot;.  When
  64 using tilde operators, prerelease versions are supported as well,
  65 but a prerelease of the next significant digit will NOT be
  66 satisfactory, so <code>1.3.0-beta</code> will not satisfy <code>~1.2.3</code>.</li><li><code>^1.2.3</code> := <code>&gt;=1.2.3-0 &lt;2.0.0-0</code>  &quot;Compatible with 1.2.3&quot;.  When
  67 using caret operators, anything from the specified version (including
  68 prerelease) will be supported up to, but not including, the next
  69 major version (or its prereleases). <code>1.5.1</code> will satisfy <code>^1.2.3</code>,
  70 while <code>1.2.2</code> and <code>2.0.0-beta</code> will not.</li><li><code>^0.1.3</code> := <code>&gt;=0.1.3-0 &lt;0.2.0-0</code> &quot;Compatible with 0.1.3&quot;. 0.x.x versions are
  71 special: the first non-zero component indicates potentially breaking changes,
  72 meaning the caret operator matches any version with the same first non-zero
  73 component starting at the specified version.</li><li><code>^0.0.2</code> := <code>=0.0.2</code> &quot;Only the version 0.0.2 is considered compatible&quot;</li><li><code>~1.2</code> := <code>&gt;=1.2.0-0 &lt;1.3.0-0</code> &quot;Any version starting with 1.2&quot;</li><li><code>^1.2</code> := <code>&gt;=1.2.0-0 &lt;2.0.0-0</code> &quot;Any version compatible with 1.2&quot;</li><li><code>1.2.x</code> := <code>&gt;=1.2.0-0 &lt;1.3.0-0</code> &quot;Any version starting with 1.2&quot;</li><li><code>~1</code> := <code>&gt;=1.0.0-0 &lt;2.0.0-0</code> &quot;Any version starting with 1&quot;</li><li><code>^1</code> := <code>&gt;=1.0.0-0 &lt;2.0.0-0</code> &quot;Any version compatible with 1&quot;</li><li><code>1.x</code> := <code>&gt;=1.0.0-0 &lt;2.0.0-0</code> &quot;Any version starting with 1&quot;</li></ul>
  74
  75 <p>Ranges can be joined with either a space (which implies &quot;and&quot;) or a
  76 <code>||</code> (which implies &quot;or&quot;).</p>
  77
  78 <h2 id="Functions">Functions</h2>
  79
  80 <p>All methods and classes take a final <code>loose</code> boolean argument that, if
  81 true, will be more forgiving about not-quite-valid semver strings.
  82 The resulting output will always be 100% strict, of course.</p>
  83
  84 <p>Strict-mode Comparators and Ranges will be strict about the SemVer
  85 strings that they parse.</p>
  86
  87 <ul><li>valid(v): Return the parsed version, or null if it&#39;s not valid.</li><li>inc(v, release): Return the version incremented by the release type
  88 (major, minor, patch, or prerelease), or null if it&#39;s not valid.</li></ul>
  89
  90 <h3 id="Comparison">Comparison</h3>
  91
  92 <ul><li>gt(v1, v2): <code>v1 &gt; v2</code></li><li>gte(v1, v2): <code>v1 &gt;= v2</code></li><li>lt(v1, v2): <code>v1 &lt; v2</code></li><li>lte(v1, v2): <code>v1 &lt;= v2</code></li><li>eq(v1, v2): <code>v1 == v2</code> This is true if they&#39;re logically equivalent,
  93 even if they&#39;re not the exact same string.  You already know how to
  94 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&#39;ll call
  95 the corresponding function above.  <code>&quot;===&quot;</code> and <code>&quot;!==&quot;</code> do simple
  96 string comparison, but are included for completeness.  Throws if an
  97 invalid comparison string is provided.</li><li>compare(v1, v2): Return 0 if v1 == v2, or 1 if v1 is greater, or -1 if
  98 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
  99 in descending order when passed to Array.sort().</li></ul>
 100
 101 <h3 id="Ranges">Ranges</h3>
 102
 103 <ul><li>validRange(range): Return the valid range or null if it&#39;s not valid</li><li>satisfies(version, range): Return true if the version satisfies the
 104 range.</li><li>maxSatisfying(versions, range): Return the highest version in the list
 105 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
 106 versions possible in the range.</li><li>ltr(version, range): Return true if version is less than all the
 107 versions possible in the range.</li><li>outside(version, range, hilo): Return true if the version is outside
 108 the bounds of the range in either the high or low direction.  The
 109 <code>hilo</code> argument must be either the string <code>&#39;&gt;&#39;</code> or <code>&#39;&lt;&#39;</code>.  (This is
 110 the function called by <code>gtr</code> and <code>ltr</code>.)</li></ul>
 111
 112 <p>Note that, since ranges may be non-contiguous, a version might not be
 113 greater than a range, less than a range, <em>or</em> satisfy a range!  For
 114 example, the range <code>1.2 &lt;1.2.9 || &gt;2.0.0</code> would have a hole from <code>1.2.9</code>
 115 until <code>2.0.0</code>, so the version <code>1.2.10</code> would not be greater than the
 116 range (because 2.0.1 satisfies, which is higher), nor less than the
 117 range (since 1.2.8 satisfies, which is lower), and it also does not
 118 satisfy the range.</p>
 119
 120 <p>If you want to know if a version satisfies or does not satisfy a
 121 range, use the <code>satisfies(version, range)</code> function.</p>
 122 </div>
 123
 124 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
 125 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
 126 <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td colspan=6 style="width:60px;height:10px;background:#fff">&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td></tr>
 127 <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2>&nbsp;</td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td></tr>
 128 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
 129 <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
 130 <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6>&nbsp;</td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td></tr>
 131 <tr><td colspan=5 style="width:50px;height:10px;background:#fff">&nbsp;</td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4>&nbsp;</td><td style="width:90px;height:10px;background:#fff" colspan=9>&nbsp;</td></tr>
 132 </table>
 133 <p id="footer">semver &mdash; npm@1.4.8</p>
 134