$ npm install semver semver.valid('1.2.3') // '1.2.3' semver.valid('a.b.c') // null semver.clean(' =v1.2.3 ') // '1.2.3' semver.satisfies('1.2.3', '1.x || >=2.5.0 || 5.0.0 - 7.2.3') // true semver.gt('1.2.3', '9.8.7') // false semver.lt('1.2.3', '9.8.7') // true
As a command-line utility:
$ semver -h Usage: semver <version> [<version> [...]] [-r <range> | -i <inc> | --preid <identifier> | -l | -rv] Test if version(s) satisfy the supplied range(s), and sort them. Multiple versions or ranges may be supplied, unless increment option is specified. In that case, only a single version may be used, and it is incremented by the specified level Program exits successfully if any valid version satisfies all supplied ranges, and prints all satisfying versions. If no versions are valid, or ranges are not satisfied, then exits failure. Versions are printed in ascending order, so supplying multiple versions to the utility will just sort them.
A "version" is described by the
v2.0.0 specification found at
"v" character is stripped off and ignored.
version range is a set of
comparators which specify versions
that satisfy the range.
comparator is composed of an
operator and a
version. The set
<=Less than or equal to
>=Greater than or equal to
=Equal. If no operator is specified, then equality is assumed, so this operator is optional, but MAY be included.
For example, the comparator
>=1.2.7 would match the versions
1.3.9, but not the versions
Comparators can be joined by whitespace to form a
which is satisfied by the intersection of all of the comparators
A range is composed of one or more comparator sets, joined by
version matches a range if and only if every comparator in at least
one of the
||-separated comparator sets is satisfied by the version.
For example, the range
>=1.2.7 <1.3.0 would match the versions
1.2.99, but not the versions
1.2.7 || >=1.2.9 <2.0.0 would match the versions
1.4.6, but not the versions
If a version has a prerelease tag (for example,
it will only be allowed to satisfy comparator sets if at least one
comparator with the same
[major, minor, patch] tuple also has a
For example, the range
>1.2.3-alpha.3 would be allowed to match the
1.2.3-alpha.7, but it would not be satisfied by
3.4.5-alpha.9, even though
3.4.5-alpha.9 is technically "greater
1.2.3-alpha.3 according to the SemVer sort rules. The version
range only accepts prerelease tags on the
1.2.3 version. The
3.4.5 would satisfy the range, because it does not have a
prerelease flag, and
3.4.5 is greater than
The purpose for this behavior is twofold. First, prerelease versions frequently are updated very quickly, and contain many breaking changes that are (by the author's design) not yet fit for public consumption. Therefore, by default, they are excluded from range matching semantics.
Second, a user who has opted into using a prerelease version has clearly indicated the intent to use that specific set of alpha/beta/rc versions. By including a prerelease tag in the range, the user is indicating that they are aware of the risk. However, it is still not appropriate to assume that they have opted into taking a similar risk on the next set of prerelease versions.
.inc takes an additional
identifier string argument that
will append the value of the string as a prerelease identifier:
> semverinc'1.2.3' 'pre' 'beta''1.2.4-beta.0'```command-line example:```shell$ semver 1.23 -i prerelease --preid beta1.24-beta0```Which then can be used to increment further:```shell$ semver 1.24-beta0 -i prerelease1.24-beta1```### Advanced Range SyntaxAdvanced range syntax desugars to primitive comparators indeterministic ways.Advanced ranges may be combined in the same way as primitivecomparators using white space or `||`.#### Hyphen Ranges `XYZ - ABC`Specifies an inclusive set.* `1.23 - 2.34` := `>=1.23 <=2.34`If a partial version is provided as the first version in the inclusiverange, then the missing pieces are replaced with zeroes.* `1.2 - 2.34` := `>=1.20 <=2.34`If a partial version is provided as the second version in theinclusive range, then all versions that start with the supplied partsof the tuple are accepted, but nothing that would be greater than theprovided tuple parts.* `1.23 - 2.3` := `>=1.23 <2.40`* `1.23 - 2` := `>=1.23 <3.00`#### X-Ranges `1.2x` `1X` `1.2*` `*`Any of `X`, `x`, or `*` may be used to "stand in" for one of thenumeric values in the `major minor patch` tuple.* `*` := `>=0.00` (Any version satisfies)* `1x` := `>=1.00 <2.00` (Matching major version)* `1.2x` := `>=1.20 <1.30` (Matching major and minor versions)A partial version range is treated as an X-Range, so the specialcharacter is in fact optional.* `""` (empty string) := `*` := `>=0.00`* `1` := `1xx` := `>=1.00 <2.00`* `1.2` := `1.2x` := `>=1.20 <1.30`#### Tilde Ranges `~1.23` `~1.2` `~1`Allows patch-level changes if a minor version is specified on thecomparator. Allows minor-level changes if not.* `~1.23` := `>=1.23 <12+10` := `>=1.23 <1.30`* `~1.2` := `>=1.20 <12+10` := `>=1.20 <1.30` (Same as `1.2x`)* `~1` := `>=1.00 <1+10.0` := `>=1.00 <2.00` (Same as `1x`)* `~0.23` := `>=0.23 <02+10` := `>=0.23 <0.30`* `~0.2` := `>=0.20 <02+10` := `>=0.20 <0.30` (Same as `0.2x`)* `~0` := `>=0.00 <0+10.0` := `>=0.00 <1.00` (Same as `0x`)* `~1.23-beta2` := `>=1.23-beta2 <1.30` Note that prereleases inthe `1.23` version will be allowed, if they are greater than orequal to `beta2`. So, `1.23-beta4` would be allowed, but`1.24-beta2` would not, because it is a prerelease of adifferent `major minor patch` tuple.#### Caret Ranges `^1.23` `^0.25` `^0.04`Allows changes that do not modify the left-most non-zero digit in the`major minor patch` tuple. In other words, this allows patch andminor updates for versions `1.00` and above, patch updates forversions `0X >=0.10`, and *no* updates for versions `0.0X`.Many authors treat a `0x` version as if the `x` were the major"breaking-change" indicator.Caret ranges are ideal when an author may make breaking changesbetween `0.24` and `0.30` releases, which is a common practice.However, it presumes that there will *not* be breaking changes between`0.24` and `0.25`. It allows for changes that are presumed to beadditive (but non-breaking), according to commonly observed practices.* `^1.23` := `>=1.23 <2.00`* `^0.23` := `>=0.23 <0.30`* `^0.03` := `>=0.03 <0.04`* `^1.23-beta2` := `>=1.23-beta2 <2.00` Note that prereleases inthe `1.23` version will be allowed, if they are greater than orequal to `beta2`. So, `1.23-beta4` would be allowed, but`1.24-beta2` would not, because it is a prerelease of adifferent `major minor patch` tuple.* `^0.03-beta` := `>=0.03-beta <0.04` Note that prereleases in the`0.03` version *only* will be allowed, if they are greater than orequal to `beta`. So, `0.03-pr2` would be allowed.When parsing caret ranges, a missing `patch` value desugars to thenumber `0`, but will allow flexibility within that value, even if themajor and minor versions are both `0`.* `^1.2x` := `>=1.20 <2.00`* `^0.0x` := `>=0.00 <0.10`* `^0.0` := `>=0.00 <0.10`A missing `minor` and `patch` values will desugar to zero, but alsoallow flexibility within those values, even if the major version iszero.* `^1x` := `>=1.00 <2.00`* `^0x` := `>=0.00 <1.00`## FunctionsAll methods and classes take a final `loose` boolean argument that, iftrue, will be more forgiving about not-quite-valid semver strings.The resulting output will always be 100% strict, of course.Strict-mode Comparators and Ranges will be strict about the SemVerstrings that they parse.* `validv`: Return the parsed version, or null if it's not valid.* `incv release`: Return the version incremented by the releasetype (`major`, `premajor`, `minor`, `preminor`, `patch`,`prepatch`, or `prerelease`), or null if it's not valid* `premajor` in one call will bump the version up to the next majorversion and down to a prerelease of that major version.`preminor`, and `prepatch` work the same way.* If called from a non-prerelease version, the `prerelease` will work thesame as `prepatch`. It increments the patch version, then makes aprerelease. If the input version is already a prerelease it simplyincrements it.### Comparison* `gtv1 v2`: `v1 > v2`* `gtev1 v2`: `v1 >= v2`* `ltv1 v2`: `v1 < v2`* `ltev1 v2`: `v1 <= v2`* `eqv1 v2`: `v1 == v2` This is true if they're logically equivalent,even if they're not the exact same string. You already know how tocompare strings.* `neqv1 v2`: `v1 != v2` The opposite of `eq`.* `cmpv1 comparator v2`: Pass in a comparison string, and it'll callthe corresponding function above. `"==="` and `"!=="` do simplestring comparison, but are included for completeness. Throws if aninvalid comparison string is provided.* `comparev1 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 `Arraysort`.* `rcomparev1 v2`: The reverse of compare. Sorts an array of versionsin descending order when passed to `Arraysort`.* `diffv1 v2`: Returns difference between two versions by the release type(`major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, or `prerelease`),or null if the versions are the same.### Ranges* `validRangerange`: Return the valid range or null if it's not valid* `satisfiesversion range`: Return true if the version satisfies therange.* `maxSatisfyingversions range`: Return the highest version in the listthat satisfies the range, or `null` if none of them do.* `gtrversion range`: Return `true` if version is greater than all theversions possible in the range.* `ltrversion range`: Return `true` if version is less than all theversions possible in the range.* `outsideversion range hilo`: Return true if the version is outsidethe bounds of the range in either the high or low direction. The`hilo` argument must be either the string `'>'` or `'<'`. (This isthe function called by `gtr` and `ltr`.)Note that, since ranges may be non-contiguous, a version might not begreater than a range, less than a range, *or* satisfy a range! Forexample, the range `1.2 <1.29 || >2.00` would have a hole from `1.29`until `2.00`, so the version `1.210` would not be greater than therange (because `2.01` satisfies, which is higher), nor less than therange (since `1.28` satisfies, which is lower), and it also does notsatisfy the range.If you want to know if a version satisfies or does not satisfy arange, use the `satisfiesversion range` function.
Last modified January 23, 2015 Found a typo? Send a pull request!