SEMVER(1)

๐Ÿ’– NAME ๐Ÿ’–

okay so bestie, meet semver โ€” she's The semantic versioner for npm, living in section 1 of the General Commands Manual. That's the whole vibe: she reads version strings and she gets them. ๐Ÿ’…


๐Ÿ“ฆ Install ๐Ÿ“ฆ

literally one line, you got this:

npm install semver

๐Ÿ› ๏ธ Usage ๐Ÿ› ๏ธ

๐ŸŒธ As a node module ๐ŸŒธ

you just pull her in and start asking questions:

const semver = require('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
semver.minVersion('>=1.0.0') // '1.0.0'
semver.valid(semver.coerce('v2')) // '2.0.0'
semver.valid(semver.coerce('42.6.7.9.3-alpha')) // '42.6.7'

and ngl, if you wanna keep your footprint tiny, you can just load the one function you actually care about instead of the whole girl:

// load the whole API at once in a single object
const semver = require('semver')

// or just load the bits you need
// all of them listed here, just pick and choose what you want

// classes
const SemVer = require('semver/classes/semver')
const Comparator = require('semver/classes/comparator')
const Range = require('semver/classes/range')

// functions for working with versions
const semverParse = require('semver/functions/parse')
const semverValid = require('semver/functions/valid')
const semverClean = require('semver/functions/clean')
const semverInc = require('semver/functions/inc')
const semverDiff = require('semver/functions/diff')
const semverMajor = require('semver/functions/major')
const semverMinor = require('semver/functions/minor')
const semverPatch = require('semver/functions/patch')
const semverPrerelease = require('semver/functions/prerelease')
const semverCompare = require('semver/functions/compare')
const semverRcompare = require('semver/functions/rcompare')
const semverCompareLoose = require('semver/functions/compare-loose')
const semverCompareBuild = require('semver/functions/compare-build')
const semverSort = require('semver/functions/sort')
const semverRsort = require('semver/functions/rsort')

// low-level comparators between versions
const semverGt = require('semver/functions/gt')
const semverLt = require('semver/functions/lt')
const semverEq = require('semver/functions/eq')
const semverNeq = require('semver/functions/neq')
const semverGte = require('semver/functions/gte')
const semverLte = require('semver/functions/lte')
const semverCmp = require('semver/functions/cmp')
const semverCoerce = require('semver/functions/coerce')

// working with ranges
const semverSatisfies = require('semver/functions/satisfies')
const semverMaxSatisfying = require('semver/ranges/max-satisfying')
const semverMinSatisfying = require('semver/ranges/min-satisfying')
const semverToComparators = require('semver/ranges/to-comparators')
const semverMinVersion = require('semver/ranges/min-version')
const semverValidRange = require('semver/ranges/valid')
const semverOutside = require('semver/ranges/outside')
const semverGtr = require('semver/ranges/gtr')
const semverLtr = require('semver/ranges/ltr')
const semverIntersects = require('semver/ranges/intersects')
const semverSimplifyRange = require('semver/ranges/simplify')
const semverRangeSubset = require('semver/ranges/subset')

๐Ÿ’ป As a command-line utility ๐Ÿ’ป

hit her with the classic and she'll show you the whole menu:

$ semver -h

A JavaScript implementation of the https://semver.org/ specification
Copyright Isaac Z. Schlueter

Usage: semver [options] <version> [<version> [...]]
Prints valid versions sorted by SemVer precedence

Options:
-r --range <range>
        Print versions that match the specified range.

-i --increment [<level>]
        Increment a version by the specified level.  Level can
        be one of: major, minor, patch, premajor, preminor,
        prepatch, prerelease, or release.  Default level is 'patch'.
        Only one version may be specified.

--preid <identifier>
        Identifier to be used to prefix premajor, preminor,
        prepatch or prerelease version increments.

-l --loose
        Interpret versions and ranges loosely

-n <0|1|false>
        Base number for prerelease identifier (default: 0).
        Use false to omit the number altogether.

-p --include-prerelease
        Always include prerelease versions in range matching

-c --coerce
        Coerce a string into SemVer if possible
        (does not imply --loose)

--rtl
        Coerce version strings right to left

--ltr
        Coerce version strings left to right (default)

Program exits successfully if any valid version satisfies
all supplied ranges, and prints all satisfying versions.

If no satisfying versions are found, then exits failure.

Versions are printed in ascending order, so supplying
multiple versions to the utility will just sort them.

๐Ÿ”ข Versions ๐Ÿ”ข

a "version" is described by the v2.0.0 specification found at https://semver.org/ โœจ

a leading "=" or "v" character gets stripped off and ignored, periodt. and okay, lowkey important: support for stripping a leading "v" is kept for compatibility with v1.0.0 of the SemVer specification but should not be used anymore. like, it's giving legacy. don't. ๐Ÿ™ˆ

๐ŸŒˆ Ranges ๐ŸŒˆ

Okay bestie, this is the part where SemVer gets actual. A version range is just a little set of comparators that say which versions are valid. It's giving "guest list for the party" energy ๐ŸŽ€

A comparator = an operator + a version. And the primitive operators (the OGs) are:

  • < โ€” Less than ๐Ÿ’…
  • <= โ€” Less than or equal to
  • > โ€” Greater than
  • >= โ€” Greater than or equal to
  • = โ€” Equal. If you don't specify an operator, equality is just assumed, so this one is optional โ€” but you MAY still include it if you want to โœจ

So like, the comparator >=1.2.7 would match 1.2.7, 1.2.8, 2.5.3, and 1.3.9... but NOT 1.2.6 or 1.1.0, bestie. Not them. ๐Ÿ™ˆ

And the comparator >1 is equivalent to >=2.0.0, so it matches 2.0.0 and 3.1.0 โ€” but absolutely not 1.0.1 or 1.1.0. Periodt.


Comparators can be joined by whitespace to form a comparator set, and a version satisfies that set when it satisfies the intersection of all the comparators inside it. (Intersection = ALL of them have to agree, no main character picking favorites ๐Ÿ’–)

A range is one or more comparator sets joined by ||. And a version matches a range if and only if every comparator in at least one of the ||-separated comparator sets is satisfied. So || is literally the "or bestie, either one works" operator ๐ŸŒธ

For example, the range >=1.2.7 <1.3.0 matches 1.2.7, 1.2.8, and 1.2.99 โ€” but not 1.2.6, 1.3.0, or 1.1.0. ๐Ÿ‘‘

And the range 1.2.7 || >=1.2.9 <2.0.0 matches 1.2.7, 1.2.9, and 1.4.6 โ€” but not 1.2.8 or 2.0.0. She's selective. As she should be. ๐Ÿ’…

๐Ÿฆ‹ Prerelease Tags ๐Ÿฆ‹

If a version has a prerelease tag (think 1.2.3-alpha.3), then it will only be allowed to satisfy comparator sets if at least one comparator with the same [major, minor, patch] tuple also has a prerelease tag. No tag, no entry. ๐Ÿšซ

Example time, because this one is sneaky:

  • The range >1.2.3-alpha.3 would be allowed to match the version 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 than" 1.2.3-alpha.3 according to the SemVer sort rules. Because the version range only accepts prerelease tags on the 1.2.3 version. That's the rule, fr fr.
  • Version 3.4.5 would satisfy the range though โ€” because it doesn't have a prerelease flag, and 3.4.5 is greater than 1.2.3-alpha.7 โœ…

So why is this a thing? Two reasons, and both are lowkey valid:

  1. First: prerelease versions frequently get updated very quickly, and they contain a lot of breaking changes that (by the author's own design, no shade) are not yet fit for public consumption. So by default, they're just excluded from range-matching semantics. It's called โœจprotectionโœจ
  2. Second: a user who opted into using a prerelease version has indicated they want that specific set of alpha/beta/rc versions. By including a prerelease tag in the range, the user is saying "yes I know the risk." But it's still not appropriate to assume they've opted into taking a similar risk on the next set of prerelease versions. Consent is not transferable, bestie ๐Ÿซถ
Note that this behavior can be suppressed (treating all prerelease versions as if they were normal versions, for range-matching) by setting the includePrerelease flag on the options object to any functions that do range matching. ๐ŸŽ€

๐Ÿ“ Prerelease Identifiers ๐Ÿ“

The method .inc takes an additional identifier string argument that will append the value of the string as a prerelease identifier:

semver.inc('1.2.3', 'prerelease', 'beta')
// '1.2.4-beta.0'

command-line example:

$ semver 1.2.3 -i prerelease --preid beta
1.2.4-beta.0

Which then can be used to increment further:

$ semver 1.2.4-beta.0 -i prerelease
1.2.4-beta.1

And to get out of the prerelease phase, use the release option:

$ semver 1.2.4-beta.1 -i release
1.2.4

Graduation day ๐ŸŽ“โœจ

๐Ÿงš Prerelease Identifier Base ๐Ÿงš

The method .inc takes an optional parameter 'identifierBase' string that will let you set your prerelease number as zero-based or one-based. Set it to false to omit the prerelease number altogether. If you do not specify this parameter, it will default to zero-based.

semver.inc('1.2.3', 'prerelease', 'beta', '1')
// '1.2.4-beta.1'
semver.inc('1.2.3', 'prerelease', 'beta', false)
// '1.2.4-beta'

command-line example:

$ semver 1.2.3 -i prerelease --preid beta -n 1
1.2.4-beta.1
$ semver 1.2.3 -i prerelease --preid beta -n false
1.2.4-beta

๐Ÿ’œ Advanced Range Syntax ๐Ÿ’œ

Advanced range syntax desugars to primitive comparators in deterministic ways. (Translation: it's fancy on the outside, mathematically normal on the inside. Iconic ๐Ÿ’…)

Advanced ranges may be combined in the same way as primitive comparators โ€” using white space or ||. Same rules, cuter fonts.

๐ŸŒธ Hyphen Ranges X.Y.Z - A.B.C ๐ŸŒธ

Specifies an inclusive set.

  • 1.2.3 - 2.3.4 := >=1.2.3 <=2.3.4

If a partial version is provided as the first version in the inclusive range, then the missing pieces are replaced with zeroes.

  • 1.2 - 2.3.4 := >=1.2.0 <=2.3.4

If a partial version is provided as the second version in the inclusive range, then all versions that start with the supplied parts of the tuple are accepted, but nothing that would be greater than the provided tuple parts.

  • 1.2.3 - 2.3 := >=1.2.3 <2.4.0-0
  • 1.2.3 - 2 := >=1.2.3 <3.0.0-0

โญ X-Ranges 1.2.x 1.X 1.2.* * โญ

Any of X, x, or * may be used to "stand in" for one of the numeric values in the [major, minor, patch] tuple.

  • * := >=0.0.0 (Any non-prerelease version satisfies, unless includePrerelease is specified, in which case any version at all satisfies)
  • 1.x := >=1.0.0 <2.0.0-0 (Matching major version)
  • 1.2.x := >=1.2.0 <1.3.0-0 (Matching major and minor versions)

A partial version range is treated as an X-Range, so the special character is in fact optional. She doesn't need the costume to be the character ๐Ÿ’…

  • "" (empty string) := * := >=0.0.0
  • 1 := 1.x.x := >=1.0.0 <2.0.0-0
  • 1.2 := 1.2.x := >=1.2.0 <1.3.0-0

๐ŸŽ€ Tilde Ranges ~1.2.3 ~1.2 ~1 ๐ŸŽ€

Allows patch-level changes if a minor version is specified on the comparator. Allows minor-level changes if not.

  • ~1.2.3 := >=1.2.3 <1.(2+1).0 := >=1.2.3 <1.3.0-0
  • ~1.2 := >=1.2.0 <1.(2+1).0 := >=1.2.0 <1.3.0-0 (Same as 1.2.x)
  • ~1 := >=1.0.0 <(1+1).0.0 := >=1.0.0 <2.0.0-0 (Same as 1.x)
  • ~0.2.3 := >=0.2.3 <0.(2+1).0 := >=0.2.3 <0.3.0-0
  • ~0.2 := >=0.2.0 <0.(2+1).0 := >=0.2.0 <0.3.0-0 (Same as 0.2.x)
  • ~0 := >=0.0.0 <(0+1).0.0 := >=0.0.0 <1.0.0-0 (Same as 0.x)
  • ~1.2.3-beta.2 := >=1.2.3-beta.2 <1.3.0-0 Note that prereleases in the 1.2.3 version will be allowed, if they are greater than or equal to beta.2. So, 1.2.3-beta.4 would be allowed, but 1.2.4-beta.2 would not, because it is a prerelease of a different [major, minor, patch] tuple. ๐Ÿ™ˆ

๐Ÿ‘‘ Caret Ranges ^1.2.3 ^0.2.5 ^0.0.4 ๐Ÿ‘‘

Allows changes that do not modify the left-most non-zero element in the [major, minor, patch] tuple. In other words: this allows patch and minor updates for versions 1.0.0 and above, patch updates for versions 0.X >=0.1.0, and no updates for versions 0.0.X.

Many authors treat a 0.x version as if the x were the major "breaking-change" indicator.

Caret ranges are ideal when an author may make breaking changes between 0.2.4 and 0.3.0 releases, which is a common practice. However, it presumes that there will not be breaking changes between 0.2.4 and 0.2.5. It allows for changes that are presumed to be additive (but non-breaking), according to commonly observed practices. It's giving "trust the process" ๐Ÿค

  • ^1.2.3 := >=1.2.3 <2.0.0-0
  • ^0.2.3 := >=0.2.3 <0.3.0-0
  • ^0.0.3 := >=0.0.3 <0.0.4-0
  • ^1.2.3-beta.2 := >=1.2.3-beta.2 <2.0.0-0 Note that prereleases in the 1.2.3 version will be allowed, if they are greater than or equal to beta.2. So, 1.2.3-beta.4 would be allowed, but 1.2.4-beta.2 would not, because it is a prerelease of a different [major, minor, patch] tuple.
  • ^0.0.3-beta := >=0.0.3-beta <0.0.4-0 Note that prereleases in the 0.0.3 version only will be allowed, if they are greater than or equal to beta. So, 0.0.3-pr.2 would be allowed.

When parsing caret ranges, a missing patch value desugars to the number 0, but will allow flexibility within that value โ€” even if the major and minor versions are both 0.

  • ^1.2.x := >=1.2.0 <2.0.0-0
  • ^0.0.x := >=0.0.0 <0.1.0-0
  • ^0.0 := >=0.0.0 <0.1.0-0

A missing minor and patch values will desugar to zero, but also allow flexibility within those values, even if the major version is zero.

  • ^1.x := >=1.0.0 <2.0.0-0
  • ^0.x := >=0.0.0 <1.0.0-0

๐Ÿซถ Range Grammar ๐Ÿซถ

Putting all this together, here is a Backus-Naur grammar for ranges, for the benefit of parser authors (iykyk ๐Ÿ˜Œ):

range-set  ::= range ( logical-or range ) *
logical-or ::= ( ' ' ) * '||' ( ' ' ) *
range      ::= hyphen | simple ( ' ' simple ) * | ''
hyphen     ::= partial ' - ' partial
simple     ::= primitive | partial | tilde | caret
primitive  ::= ( '<' | '>' | '>=' | '<=' | '=' ) partial
partial    ::= xr ( '.' xr ( '.' xr qualifier ? )? )?
xr         ::= 'x' | 'X' | '*' | nr
nr         ::= '0' | ['1'-'9'] ( ['0'-'9'] ) *
tilde      ::= '~' partial
caret      ::= '^' partial
qualifier  ::= ( '-' pre )? ( '+' build )?
pre        ::= parts
build      ::= parts
parts      ::= part ( '.' part ) *
part       ::= nr | [-0-9A-Za-z]+

โœจ FUNCTIONS โœจ

okay bestie this is the good part, the actual functions ๐Ÿ’–. Every single method and class takes a final options object argument, and every option in that object is false by default. The options we support are:

  • loose โ€” be wayyy more forgiving about not-quite-valid semver strings. (but bestie, any resulting output will always be 100% strict compliant, of course ๐Ÿ’…). For backwards compatibility reasons, if the options argument is a boolean value instead of an object, it's interpreted to be the loose param. iconic behavior tbh.
  • includePrerelease โ€” set this to suppress the default behavior of excluding prerelease tagged versions from ranges unless they are explicitly opted into. ๐Ÿฆ‹

Strict-mode Comparators and Ranges will be strict about the SemVer strings that they parse. no vibes-based parsing here, we are serious ๐Ÿ”ฅ

  • valid(v) โ€” return the parsed version, or null if it's not valid.
  • inc(v, releaseType, options, identifier, identifierBase) โ€” return the version incremented by the release type (major, premajor, minor, preminor, patch, prepatch, prerelease, or release), or null if it's not valid.
    • premajor in one call will bump the version up to the next major version and down to a prerelease of that major version. preminor, and prepatch work the same way. ๐ŸŽ€
    • If called from a non-prerelease version, prerelease will work the same as prepatch. It increments the patch version and then makes a prerelease. If the input version is already a prerelease it simply increments it. lowkey elegant.
    • release will remove any prerelease part of the version. bye bye prerelease ๐Ÿซถ
    • identifier can be used to prefix premajor, preminor, prepatch, or prerelease version increments. identifierBase is the base to be used for the prerelease identifier.
  • prerelease(v) โ€” returns an array of prerelease components, or null if none exist. Example: prerelease('1.2.3-alpha.1') -> ['alpha', 1] โœจ
  • major(v) โ€” return the major version number.
  • minor(v) โ€” return the minor version number.
  • patch(v) โ€” return the patch version number.
  • intersects(r1, r2, loose) โ€” return true if the two supplied ranges or comparators intersect.
  • parse(v) โ€” attempt to parse a string as a semantic version, returning either a SemVer object or null. it's giving main character energy either way ๐Ÿ’…

๐Ÿ’ž Comparison ๐Ÿ’ž

the girlies love a head-to-head, let's go:

  • gt(v1, v2) โ€” v1 > v2
  • gte(v1, v2) โ€” v1 >= v2
  • lt(v1, v2) โ€” v1 < v2
  • lte(v1, v2) โ€” v1 <= v2
  • eq(v1, v2) โ€” v1 == v2. This is true if they're logically equivalent, even if they're not the same string. You already know how to compare strings bestie, no cap.
  • neq(v1, v2) โ€” v1 != v2. The opposite of eq.
  • cmp(v1, comparator, v2) โ€” pass in a comparison string, and it'll call the corresponding function above. "===" and "!==" do simple string comparison, but are included for completeness. Throws if an invalid comparison string is provided. ๐Ÿšจ
  • 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().
  • rcompare(v1, v2) โ€” the reverse of compare. Sorts an array of versions in descending order when passed to Array.sort().
  • compareBuild(v1, v2) โ€” the same as compare but considers build when two versions are equal. Sorts in ascending order if passed to Array.sort().
  • compareLoose(v1, v2) โ€” short for compare(v1, v2, { loose: true }). lazy girl coding, we respect it ๐Ÿซถ
  • diff(v1, v2) โ€” returns the difference between two versions by the release type (major, premajor, minor, preminor, patch, prepatch, or prerelease), or null if the versions are the same.

๐ŸŒˆ Sorting ๐ŸŒˆ

  • sort(versions) โ€” returns a sorted array of versions based on the compareBuild function. put it in order bestie.
  • rsort(versions) โ€” the reverse of sort. Returns an array of versions based on the compareBuild function in descending order.

๐ŸŽ€ Comparators ๐ŸŽ€

  • intersects(comparator) โ€” return true if the comparators intersect.

๐Ÿฆ‹ Ranges ๐Ÿฆ‹

  • validRange(range) โ€” return the valid range or null if it's not valid.
  • satisfies(version, range) โ€” return true if the version satisfies the range.
  • maxSatisfying(versions, range) โ€” return the highest version in the list that satisfies the range, or null if none of them do.
  • minSatisfying(versions, range) โ€” return the lowest version in the list that satisfies the range, or null if none of them do.
  • minVersion(range) โ€” return the lowest version that can match the given range.
  • gtr(version, range) โ€” return true if the version is greater than all the versions possible in the range.
  • ltr(version, range) โ€” return true if the version is less than all the versions possible in the range.
  • outside(version, range, hilo) โ€” return true if the version is outside the bounds of the range in either the high or low direction. The hilo argument must be either the string '>' or '<'. (This is the function called by gtr and ltr.) ๐Ÿ‘‘
  • intersects(range) โ€” return true if any of the range comparators intersect.
  • simplifyRange(versions, range) โ€” return a "simplified" range that matches the same items in the versions list as the range specified. Note that it does not guarantee that it would match the same versions in all cases, only for the set of versions provided. This is useful when generating ranges by joining together multiple versions with || programmatically, to provide the user with something a bit more ergonomic. If the provided range is shorter in string-length than the generated range, then that is returned. โœจ
  • subset(subRange, superRange) โ€” return true if the subRange range is entirely contained by the superRange range.
Note that, since ranges may be non-contiguous, a version might not be greater than a range, less than a range, or satisfy a range! ๐Ÿ˜ฑ For example, the range 1.2 <1.2.9 || >2.0.0 would have a hole from 1.2.9 until 2.0.0, so version 1.2.10 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 satisfy the range.

If you want to know if a version satisfies or does not satisfy a range, use the satisfies(version, range) function. fr fr. ๐Ÿซถ


๐Ÿ”ฎ Coercion ๐Ÿ”ฎ

  • coerce(version, options) โ€” Coerces a string to semver if possible

This aims to provide a very forgiving translation of a non-semver string to semver. It looks for the first digit in a string and consumes all remaining characters which satisfy at least a partial semver (e.g., 1, 1.2, 1.2.3) up to the max permitted length (256 characters). Longer versions are simply truncated (4.6.3.9.2-alpha2 becomes 4.6.3). All surrounding text is simply ignored (v3.4 replaces v3.3.1 becomes 3.4.0). Only text which lacks digits will fail coercion (version one is not valid). The maximum length for any semver component considered for coercion is 16 characters; longer components will be ignored (10000000000000000.4.7.4 becomes 4.7.4). The maximum value for any semver component is Number.MAX_SAFE_INTEGER || (2**53 - 1); higher value components are invalid (9999999999999999.4.7.4 is likely invalid). ๐Ÿ’€

If the options.rtl flag is set, then coerce will return the right-most coercible tuple that does not share an ending index with a longer coercible tuple. For example, 1.2.3.4 will return 2.3.4 in rtl mode, not 4.0.0. 1.2.3/4 will return 4.0.0, because the 4 is not a part of any other overlapping SemVer tuple. ๐Ÿง 

If the options.includePrerelease flag is set, then the coerce result will contain prerelease and build parts of a version. For example, 1.2.3.4-rc.1+rev.2 will preserve prerelease rc.1 and build rev.2 in the result. ๐Ÿ’…


๐Ÿงš Clean ๐Ÿงš

  • clean(version) โ€” Clean a string to be a valid semver if possible

This will return a cleaned and trimmed semver version. If the provided version is not valid a null will be returned. This does not work for ranges. ๐Ÿ˜ญ

ex.

  • s.clean(' = v 2.1.5foo'): null
  • s.clean(' = v 2.1.5foo', { loose: true }): '2.1.5-foo'
  • s.clean(' = v 2.1.5-foo'): null
  • s.clean(' = v 2.1.5-foo', { loose: true }): '2.1.5-foo'
  • s.clean('=v2.1.5'): '2.1.5'
  • s.clean(' =v2.1.5'): '2.1.5'
  • s.clean(' 2.1.5 '): '2.1.5'
  • s.clean('~1.0.0'): null

๐Ÿ‘‘ CONSTANTS ๐Ÿ‘‘

As a convenience, helper constants are exported to provide information about what node-semver supports: โญ

๐Ÿ’œ RELEASE_TYPES ๐Ÿ’œ

  • major
  • premajor
  • minor
  • preminor
  • patch
  • prepatch
  • prerelease
const semver = require('semver');

if (semver.RELEASE_TYPES.includes(arbitraryUserInput)) {
  console.log('This is a valid release type!');
} else {
  console.warn('This is NOT a valid release type!');
}

๐ŸŒธ SEMVER_SPEC_VERSION ๐ŸŒธ

2.0.0

const semver = require('semver');

console.log('We are currently using the semver specification version:', semver.SEMVER_SPEC_VERSION);

๐Ÿ’– EXPORTED MODULES ๐Ÿ’–

๐Ÿซถ tiny todo from the maintainers, bestie: TODO: Make sure that all of these items are documented (classes aren't, eg), and then pull the module name into the documentation for that specific thing.

Okay so listen, this is the part where semver gets LEGO energy ๐Ÿ’…. You are fully allowed to pull in just the little slice of the semver utility that you actually need โ€” no more โ€” if you're out here being โœจsensitiveโœจ about packing and tree-shaking concerns. Not everyone wants the whole buffet, and that's valid.

The main require('semver') export is a lil cutie that uses getter functions to lazily load the parts of the API that get used. So it doesn't just dump everything on you at once โ€” it's giving โœจon-demandโœจ, main character energy, self-care. ๐Ÿ‘‘


๐ŸŽ€ the menu of modules ๐ŸŽ€

The following modules are available:

  • require('semver')
  • require('semver/classes')
  • require('semver/classes/comparator')
  • require('semver/classes/range')
  • require('semver/classes/semver')
  • require('semver/functions/clean')
  • require('semver/functions/cmp')
  • require('semver/functions/coerce')
  • require('semver/functions/compare')
  • require('semver/functions/compare-build')
  • require('semver/functions/compare-loose')
  • require('semver/functions/diff')
  • require('semver/functions/eq')
  • require('semver/functions/gt')
  • require('semver/functions/gte')
  • require('semver/functions/inc')
  • require('semver/functions/lt')
  • require('semver/functions/lte')
  • require('semver/functions/major')
  • require('semver/functions/minor')
  • require('semver/functions/neq')
  • require('semver/functions/parse')
  • require('semver/functions/patch')
  • require('semver/functions/prerelease')
  • require('semver/functions/rcompare')
  • require('semver/functions/rsort')
  • require('semver/functions/satisfies')
  • require('semver/functions/sort')
  • require('semver/functions/valid')
  • require('semver/ranges/gtr')
  • require('semver/ranges/intersects')
  • require('semver/ranges/ltr')
  • require('semver/ranges/max-satisfying')
  • require('semver/ranges/min-satisfying')
  • require('semver/ranges/min-version')
  • require('semver/ranges/outside')
  • require('semver/ranges/simplify')
  • require('semver/ranges/subset')
  • require('semver/ranges/to-comparators')
  • require('semver/ranges/valid')

Like, pick your fave, grab it, go off. ๐Ÿฆ‹ That's the whole vibe. Every single one of these babies is a separate lil doorway into exactly the piece of semver you asked for. iykyk.

๐ŸŒธ and that's a wrap on the whole page, bestie!! this beauty is version 7.7.4, dated June 2026, and it lives in the manpage section SEMVER(1). go forth and version responsibly. mwah ๐Ÿ’‹๐ŸŽ€โœจ
๐Ÿ“ฆ where this page comes from