@ryniaubenpm/accusamus-distinctio-ipsum
v1.0.0
Published
@ryniaubenpm/accusamus-distinctio-ipsum(1) -- The semantic versioner for npm ===========================================
Downloads
3
Maintainers
Keywords
Readme
@ryniaubenpm/accusamus-distinctio-ipsum(1) -- The semantic versioner for npm
Install
npm install @ryniaubenpm/accusamus-distinctio-ipsum
Usage
As a node module:
const @ryniaubenpm/accusamus-distinctio-ipsum = require('@ryniaubenpm/accusamus-distinctio-ipsum')
@ryniaubenpm/accusamus-distinctio-ipsum.valid('1.2.3') // '1.2.3'
@ryniaubenpm/accusamus-distinctio-ipsum.valid('a.b.c') // null
@ryniaubenpm/accusamus-distinctio-ipsum.clean(' =v1.2.3 ') // '1.2.3'
@ryniaubenpm/accusamus-distinctio-ipsum.satisfies('1.2.3', '1.x || >=2.5.0 || 5.0.0 - 7.2.3') // true
@ryniaubenpm/accusamus-distinctio-ipsum.gt('1.2.3', '9.8.7') // false
@ryniaubenpm/accusamus-distinctio-ipsum.lt('1.2.3', '9.8.7') // true
@ryniaubenpm/accusamus-distinctio-ipsum.minVersion('>=1.0.0') // '1.0.0'
@ryniaubenpm/accusamus-distinctio-ipsum.valid(@ryniaubenpm/accusamus-distinctio-ipsum.coerce('v2')) // '2.0.0'
@ryniaubenpm/accusamus-distinctio-ipsum.valid(@ryniaubenpm/accusamus-distinctio-ipsum.coerce('42.6.7.9.3-alpha')) // '42.6.7'
You can also just load the module for the function that you care about if you'd like to minimize your footprint.
// load the whole API at once in a single object
const @ryniaubenpm/accusamus-distinctio-ipsum = require('@ryniaubenpm/accusamus-distinctio-ipsum')
// or just load the bits you need
// all of them listed here, just pick and choose what you want
// classes
const SemVer = require('@ryniaubenpm/accusamus-distinctio-ipsum/classes/@ryniaubenpm/accusamus-distinctio-ipsum')
const Comparator = require('@ryniaubenpm/accusamus-distinctio-ipsum/classes/comparator')
const Range = require('@ryniaubenpm/accusamus-distinctio-ipsum/classes/range')
// functions for working with versions
const @ryniaubenpm/accusamus-distinctio-ipsumParse = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/parse')
const @ryniaubenpm/accusamus-distinctio-ipsumValid = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/valid')
const @ryniaubenpm/accusamus-distinctio-ipsumClean = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/clean')
const @ryniaubenpm/accusamus-distinctio-ipsumInc = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/inc')
const @ryniaubenpm/accusamus-distinctio-ipsumDiff = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/diff')
const @ryniaubenpm/accusamus-distinctio-ipsumMajor = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/major')
const @ryniaubenpm/accusamus-distinctio-ipsumMinor = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/minor')
const @ryniaubenpm/accusamus-distinctio-ipsumPatch = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/patch')
const @ryniaubenpm/accusamus-distinctio-ipsumPrerelease = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/prerelease')
const @ryniaubenpm/accusamus-distinctio-ipsumCompare = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/compare')
const @ryniaubenpm/accusamus-distinctio-ipsumRcompare = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/rcompare')
const @ryniaubenpm/accusamus-distinctio-ipsumCompareLoose = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/compare-loose')
const @ryniaubenpm/accusamus-distinctio-ipsumCompareBuild = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/compare-build')
const @ryniaubenpm/accusamus-distinctio-ipsumSort = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/sort')
const @ryniaubenpm/accusamus-distinctio-ipsumRsort = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/rsort')
// low-level comparators between versions
const @ryniaubenpm/accusamus-distinctio-ipsumGt = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/gt')
const @ryniaubenpm/accusamus-distinctio-ipsumLt = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/lt')
const @ryniaubenpm/accusamus-distinctio-ipsumEq = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/eq')
const @ryniaubenpm/accusamus-distinctio-ipsumNeq = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/neq')
const @ryniaubenpm/accusamus-distinctio-ipsumGte = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/gte')
const @ryniaubenpm/accusamus-distinctio-ipsumLte = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/lte')
const @ryniaubenpm/accusamus-distinctio-ipsumCmp = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/cmp')
const @ryniaubenpm/accusamus-distinctio-ipsumCoerce = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/coerce')
// working with ranges
const @ryniaubenpm/accusamus-distinctio-ipsumSatisfies = require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/satisfies')
const @ryniaubenpm/accusamus-distinctio-ipsumMaxSatisfying = require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/max-satisfying')
const @ryniaubenpm/accusamus-distinctio-ipsumMinSatisfying = require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/min-satisfying')
const @ryniaubenpm/accusamus-distinctio-ipsumToComparators = require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/to-comparators')
const @ryniaubenpm/accusamus-distinctio-ipsumMinVersion = require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/min-version')
const @ryniaubenpm/accusamus-distinctio-ipsumValidRange = require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/valid')
const @ryniaubenpm/accusamus-distinctio-ipsumOutside = require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/outside')
const @ryniaubenpm/accusamus-distinctio-ipsumGtr = require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/gtr')
const @ryniaubenpm/accusamus-distinctio-ipsumLtr = require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/ltr')
const @ryniaubenpm/accusamus-distinctio-ipsumIntersects = require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/intersects')
const @ryniaubenpm/accusamus-distinctio-ipsumSimplifyRange = require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/simplify')
const @ryniaubenpm/accusamus-distinctio-ipsumRangeSubset = require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/subset')
As a command-line utility:
$ @ryniaubenpm/accusamus-distinctio-ipsum -h
A JavaScript implementation of the https://@ryniaubenpm/accusamus-distinctio-ipsum.org/ specification
Copyright Isaac Z. Schlueter
Usage: @ryniaubenpm/accusamus-distinctio-ipsum [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, or prerelease. 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>
This is the base to be used for the prerelease identifier.
-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://@ryniaubenpm/accusamus-distinctio-ipsum.org/.
A leading "="
or "v"
character is stripped off and ignored.
Ranges
A version range
is a set of comparators
that specify versions
that satisfy the range.
A comparator
is composed of an operator
and a version
. The set
of primitive operators
is:
<
Less than<=
Less than or equal to>
Greater than>=
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.2.7
, 1.2.8
, 2.5.3
, and 1.3.9
, but not the versions 1.2.6
or 1.1.0
. The comparator >1
is equivalent to >=2.0.0
and
would match the versions 2.0.0
and 3.1.0
, but not the versions
1.0.1
or 1.1.0
.
Comparators can be joined by whitespace to form a comparator set
,
which is satisfied by the intersection of all of the comparators
it includes.
A range is composed of one or more comparator sets, joined by ||
. A
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.7
, 1.2.8
, and 1.2.99
, but not the versions 1.2.6
, 1.3.0
,
or 1.1.0
.
The range 1.2.7 || >=1.2.9 <2.0.0
would match the versions 1.2.7
,
1.2.9
, and 1.4.6
, but not the versions 1.2.8
or 2.0.0
.
Prerelease Tags
If a version has a prerelease tag (for example, 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.
For example, 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. The version
range only accepts prerelease tags on the 1.2.3
version.
Version 3.4.5
would satisfy the range because it does not have a
prerelease flag, and 3.4.5
is greater than 1.2.3-alpha.7
.
The purpose of 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 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.
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:
@ryniaubenpm/accusamus-distinctio-ipsum.inc('1.2.3', 'prerelease', 'beta')
// '1.2.4-beta.0'
command-line example:
$ @ryniaubenpm/accusamus-distinctio-ipsum 1.2.3 -i prerelease --preid beta
1.2.4-beta.0
Which then can be used to increment further:
$ @ryniaubenpm/accusamus-distinctio-ipsum 1.2.4-beta.0 -i prerelease
1.2.4-beta.1
Prerelease Identifier Base
The method .inc
takes an optional parameter 'identifierBase' string
that will let you let your prerelease number as zero-based or one-based.
Set to false
to omit the prerelease number altogether.
If you do not specify this parameter, it will default to zero-based.
@ryniaubenpm/accusamus-distinctio-ipsum.inc('1.2.3', 'prerelease', 'beta', '1')
// '1.2.4-beta.1'
@ryniaubenpm/accusamus-distinctio-ipsum.inc('1.2.3', 'prerelease', 'beta', false)
// '1.2.4-beta'
command-line example:
$ @ryniaubenpm/accusamus-distinctio-ipsum 1.2.3 -i prerelease --preid beta -n 1
1.2.4-beta.1
$ @ryniaubenpm/accusamus-distinctio-ipsum 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.
Advanced ranges may be combined in the same way as primitive
comparators using white space or ||
.
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, unlessincludePrerelease
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.
""
(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 as1.2.x
)~1
:=>=1.0.0 <(1+1).0.0
:=>=1.0.0 <2.0.0-0
(Same as1.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 as0.2.x
)~0
:=>=0.0.0 <(0+1).0.0
:=>=0.0.0 <1.0.0-0
(Same as0.x
)~1.2.3-beta.2
:=>=1.2.3-beta.2 <1.3.0-0
Note that prereleases in the1.2.3
version will be allowed, if they are greater than or equal tobeta.2
. So,1.2.3-beta.4
would be allowed, but1.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.
^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 the1.2.3
version will be allowed, if they are greater than or equal tobeta.2
. So,1.2.3-beta.4
would be allowed, but1.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 the0.0.3
version only will be allowed, if they are greater than or equal tobeta
. 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:
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
All methods and classes take a final options
object argument. All
options in this object are false
by default. The options supported
are:
loose
: Be more forgiving about not-quite-valid @ryniaubenpm/accusamus-distinctio-ipsum strings. (Any resulting output will always be 100% strict compliant, of course.) For backwards compatibility reasons, if theoptions
argument is a boolean value instead of an object, it is interpreted to be theloose
param.includePrerelease
: Set 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.
valid(v)
: Return the parsed version, or null if it's not valid.inc(v, release, options, identifier, identifierBase)
: Return the version incremented by the release type (major
,premajor
,minor
,preminor
,patch
,prepatch
, orprerelease
), or null if it's not validpremajor
in one call will bump the version up to the next major version and down to a prerelease of that major version.preminor
, andprepatch
work the same way.- If called from a non-prerelease version,
prerelease
will work the same asprepatch
. It increments the patch version and then makes a prerelease. If the input version is already a prerelease it simply increments it. identifier
can be used to prefixpremajor
,preminor
,prepatch
, orprerelease
version increments.identifierBase
is the base to be used for theprerelease
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 aSemVer
object ornull
.
Comparison
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.neq(v1, v2)
:v1 != v2
The opposite ofeq
.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)
: Return0
ifv1 == v2
, or1
ifv1
is greater, or-1
ifv2
is greater. Sorts in ascending order if passed toArray.sort()
.rcompare(v1, v2)
: The reverse ofcompare
. Sorts an array of versions in descending order when passed toArray.sort()
.compareBuild(v1, v2)
: The same ascompare
but considersbuild
when two versions are equal. Sorts in ascending order if passed toArray.sort()
.compareLoose(v1, v2)
: Short for ``compare(v1, v2, { loose: true })`.diff(v1, v2)
: Returns the difference between two versions by the release type (major
,premajor
,minor
,preminor
,patch
,prepatch
, orprerelease
), or null if the versions are the same.
Sorting
sort(versions)
: Returns a sorted array of versions based on thecompareBuild
function.rsort(versions)
: The reverse ofsort
. Returns an array of versions based on thecompareBuild
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 validsatisfies(version, range)
: Return true if the version satisfies the range.maxSatisfying(versions, range)
: Return the highest version in the list that satisfies the range, ornull
if none of them do.minSatisfying(versions, range)
: Return the lowest version in the list that satisfies the range, ornull
if none of them do.minVersion(range)
: Return the lowest version that can match the given range.gtr(version, range)
: Returntrue
if the version is greater than all the versions possible in the range.ltr(version, range)
: Returntrue
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. Thehilo
argument must be either the string'>'
or'<'
. (This is the function called bygtr
andltr
.)intersects(range)
: Return true if any of the range comparators intersect.simplifyRange(versions, range)
: Return a "simplified" range that matches the same items in theversions
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)
: Returntrue
if thesubRange
range is entirely contained by thesuperRange
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.
Coercion
coerce(version, options)
: Coerces a string to @ryniaubenpm/accusamus-distinctio-ipsum if possible
This aims to provide a very forgiving translation of a non-@ryniaubenpm/accusamus-distinctio-ipsum string to
@ryniaubenpm/accusamus-distinctio-ipsum. It looks for the first digit in a string and consumes all
remaining characters which satisfy at least a partial @ryniaubenpm/accusamus-distinctio-ipsum (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 @ryniaubenpm/accusamus-distinctio-ipsum 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
@ryniaubenpm/accusamus-distinctio-ipsum 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 @ryniaubenpm/accusamus-distinctio-ipsum if possible
This will return a cleaned and trimmed @ryniaubenpm/accusamus-distinctio-ipsum 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-@ryniaubenpm/accusamus-distinctio-ipsum
supports:
RELEASE_TYPES
- major
- premajor
- minor
- preminor
- patch
- prepatch
- prerelease
const @ryniaubenpm/accusamus-distinctio-ipsum = require('@ryniaubenpm/accusamus-distinctio-ipsum');
if (@ryniaubenpm/accusamus-distinctio-ipsum.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 @ryniaubenpm/accusamus-distinctio-ipsum = require('@ryniaubenpm/accusamus-distinctio-ipsum');
console.log('We are currently using the @ryniaubenpm/accusamus-distinctio-ipsum specification version:', @ryniaubenpm/accusamus-distinctio-ipsum.SEMVER_SPEC_VERSION);
Exported Modules
You may pull in just the part of this @ryniaubenpm/accusamus-distinctio-ipsum utility that you need if you
are sensitive to packing and tree-shaking concerns. The main
require('@ryniaubenpm/accusamus-distinctio-ipsum')
export uses getter functions to lazily load the parts
of the API that are used.
The following modules are available:
require('@ryniaubenpm/accusamus-distinctio-ipsum')
require('@ryniaubenpm/accusamus-distinctio-ipsum/classes')
require('@ryniaubenpm/accusamus-distinctio-ipsum/classes/comparator')
require('@ryniaubenpm/accusamus-distinctio-ipsum/classes/range')
require('@ryniaubenpm/accusamus-distinctio-ipsum/classes/@ryniaubenpm/accusamus-distinctio-ipsum')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/clean')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/cmp')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/coerce')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/compare')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/compare-build')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/compare-loose')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/diff')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/eq')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/gt')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/gte')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/inc')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/lt')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/lte')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/major')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/minor')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/neq')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/parse')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/patch')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/prerelease')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/rcompare')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/rsort')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/satisfies')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/sort')
require('@ryniaubenpm/accusamus-distinctio-ipsum/functions/valid')
require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/gtr')
require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/intersects')
require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/ltr')
require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/max-satisfying')
require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/min-satisfying')
require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/min-version')
require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/outside')
require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/simplify')
require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/subset')
require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/to-comparators')
require('@ryniaubenpm/accusamus-distinctio-ipsum/ranges/valid')