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>
12 <h1><a href="../misc/semver.html">semver</a></h1> <p>The semantic versioner for npm</p>
13 <h2 id="usage">Usage</h2>
14 <pre><code>$ npm install semver
16 semver.valid('1.2.3') // '1.2.3'
17 semver.valid('a.b.c') // null
18 semver.clean(' =v1.2.3 ') // '1.2.3'
19 semver.satisfies('1.2.3', '1.x || >=2.5.0 || 5.0.0 - 7.2.3') // true
20 semver.gt('1.2.3', '9.8.7') // false
21 semver.lt('1.2.3', '9.8.7') // true
22 </code></pre><p>As a command-line utility:</p>
23 <pre><code>$ semver -h
25 Usage: semver <version> [<version> [...]] [-r <range> | -i <inc> | -d <dec>]
26 Test if version(s) satisfy the supplied range(s), and sort them.
28 Multiple versions or ranges may be supplied, unless increment
29 or decrement options are specified. In that case, only a single
30 version may be used, and it is incremented by the specified level
32 Program exits successfully if any valid version satisfies
33 all supplied ranges, and prints all satisfying versions.
35 If no versions are valid, or ranges are not satisfied,
38 Versions are printed in ascending order, so supplying
39 multiple versions to the utility will just sort them.
40 </code></pre><h2 id="versions">Versions</h2>
41 <p>A "version" is described by the <code>v2.0.0</code> specification found at
42 <a href="http://semver.org/">http://semver.org/</a>.</p>
43 <p>A leading <code>"="</code> or <code>"v"</code> character is stripped off and ignored.</p>
44 <h2 id="ranges">Ranges</h2>
45 <p>The following range styles are supported:</p>
47 <li><code>1.2.3</code> A specific version. When nothing else will do. Must be a full
48 version number, with major, minor, and patch versions specified.
49 Note that build metadata is still ignored, so <code>1.2.3+build2012</code> will
50 satisfy this range.</li>
51 <li><code>>1.2.3</code> Greater than a specific version.</li>
52 <li><code><1.2.3</code> Less than a specific version. If there is no prerelease
53 tag on the version range, then no prerelease version will be allowed
54 either, even though these are technically "less than".</li>
55 <li><code>>=1.2.3</code> Greater than or equal to. Note that prerelease versions
56 are NOT equal to their "normal" equivalents, so <code>1.2.3-beta</code> will
57 not satisfy this range, but <code>2.3.0-beta</code> will.</li>
58 <li><code><=1.2.3</code> Less than or equal to. In this case, prerelease versions
59 ARE allowed, so <code>1.2.3-beta</code> would satisfy.</li>
60 <li><code>1.2.3 - 2.3.4</code> := <code>>=1.2.3 <=2.3.4</code></li>
61 <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
62 using tilde operators, prerelease versions are supported as well,
63 but a prerelease of the next significant digit will NOT be
64 satisfactory, so <code>1.3.0-beta</code> will not satisfy <code>~1.2.3</code>.</li>
65 <li><code>^1.2.3</code> := <code>>=1.2.3-0 <2.0.0-0</code> "Compatible with <code>1.2.3</code>". When
66 using caret operators, anything from the specified version (including
67 prerelease) will be supported up to, but not including, the next
68 major version (or its prereleases). <code>1.5.1</code> will satisfy <code>^1.2.3</code>,
69 while <code>1.2.2</code> and <code>2.0.0-beta</code> will not.</li>
70 <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
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>
74 <li><code>^0.0.2</code> := <code>=0.0.2</code> "Only the version <code>0.0.2</code> is considered compatible"</li>
75 <li><code>~1.2</code> := <code>>=1.2.0-0 <1.3.0-0</code> "Any version starting with <code>1.2</code>"</li>
76 <li><code>^1.2</code> := <code>>=1.2.0-0 <2.0.0-0</code> "Any version compatible with <code>1.2</code>"</li>
77 <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>
78 <li><code>1.2.*</code> Same as <code>1.2.x</code>.</li>
79 <li><code>1.2</code> Same as <code>1.2.x</code>.</li>
80 <li><code>~1</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version starting with <code>1</code>"</li>
81 <li><code>^1</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version compatible with <code>1</code>"</li>
82 <li><code>1.x</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version starting with <code>1</code>"</li>
83 <li><code>1.*</code> Same as <code>1.x</code>.</li>
84 <li><code>1</code> Same as <code>1.x</code>.</li>
85 <li><code>*</code> Any version whatsoever.</li>
86 <li><code>x</code> Same as <code>*</code>.</li>
87 <li><code>""</code> (just an empty string) Same as <code>*</code>.</li>
89 <p>Ranges can be joined with either a space (which implies "and") or a
90 <code>||</code> (which implies "or").</p>
91 <h2 id="functions">Functions</h2>
92 <p>All methods and classes take a final <code>loose</code> boolean argument that, if
93 true, will be more forgiving about not-quite-valid semver strings.
94 The resulting output will always be 100% strict, of course.</p>
95 <p>Strict-mode Comparators and Ranges will be strict about the SemVer
96 strings that they parse.</p>
98 <li><code>valid(v)</code>: Return the parsed version, or null if it's not valid.</li>
99 <li><code>inc(v, release)</code>: Return the version incremented by the release
100 type (<code>major</code>, <code>premajor</code>, <code>minor</code>, <code>preminor</code>, <code>patch</code>,
101 <code>prepatch</code>, or <code>prerelease</code>), or null if it's not valid<ul>
102 <li><code>premajor</code> in one call will bump the version up to the next major
103 version and down to a prerelease of that major version.
104 <code>preminor</code>, and <code>prepatch</code> work the same way.</li>
105 <li>If called from a non-prerelease version, the <code>prerelease</code> will work the
106 same as <code>prepatch</code>. It increments the patch version, then makes a
107 prerelease. If the input version is already a prerelease it simply
112 <h3 id="comparison">Comparison</h3>
114 <li><code>gt(v1, v2)</code>: <code>v1 > v2</code></li>
115 <li><code>gte(v1, v2)</code>: <code>v1 >= v2</code></li>
116 <li><code>lt(v1, v2)</code>: <code>v1 < v2</code></li>
117 <li><code>lte(v1, v2)</code>: <code>v1 <= v2</code></li>
118 <li><code>eq(v1, v2)</code>: <code>v1 == v2</code> This is true if they're logically equivalent,
119 even if they're not the exact same string. You already know how to
120 compare strings.</li>
121 <li><code>neq(v1, v2)</code>: <code>v1 != v2</code> The opposite of <code>eq</code>.</li>
122 <li><code>cmp(v1, comparator, v2)</code>: Pass in a comparison string, and it'll call
123 the corresponding function above. <code>"==="</code> and <code>"!=="</code> do simple
124 string comparison, but are included for completeness. Throws if an
125 invalid comparison string is provided.</li>
126 <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
127 <code>v2</code> is greater. Sorts in ascending order if passed to <code>Array.sort()</code>.</li>
128 <li><code>rcompare(v1, v2)</code>: The reverse of compare. Sorts an array of versions
129 in descending order when passed to <code>Array.sort()</code>.</li>
131 <h3 id="ranges">Ranges</h3>
133 <li><code>validRange(range)</code>: Return the valid range or null if it's not valid</li>
134 <li><code>satisfies(version, range)</code>: Return true if the version satisfies the
136 <li><code>maxSatisfying(versions, range)</code>: Return the highest version in the list
137 that satisfies the range, or <code>null</code> if none of them do.</li>
138 <li><code>gtr(version, range)</code>: Return <code>true</code> if version is greater than all the
139 versions possible in the range.</li>
140 <li><code>ltr(version, range)</code>: Return <code>true</code> if version is less than all the
141 versions possible in the range.</li>
142 <li><code>outside(version, range, hilo)</code>: Return true if the version is outside
143 the bounds of the range in either the high or low direction. The
144 <code>hilo</code> argument must be either the string <code>'>'</code> or <code>'<'</code>. (This is
145 the function called by <code>gtr</code> and <code>ltr</code>.)</li>
147 <p>Note that, since ranges may be non-contiguous, a version might not be
148 greater than a range, less than a range, <em>or</em> satisfy a range! For
149 example, the range <code>1.2 <1.2.9 || >2.0.0</code> would have a hole from <code>1.2.9</code>
150 until <code>2.0.0</code>, so the version <code>1.2.10</code> would not be greater than the
151 range (because <code>2.0.1</code> satisfies, which is higher), nor less than the
152 range (since <code>1.2.8</code> satisfies, which is lower), and it also does not
153 satisfy the range.</p>
154 <p>If you want to know if a version satisfies or does not satisfy a
155 range, use the <code>satisfies(version, range)</code> function.</p>
159 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
160 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
161 <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
162 <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
163 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
164 <tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
165 <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>
166 <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>
168 <p id="footer">semver — npm@1.4.28</p>
projects / platform / upstream / nodejs.git / blob