diff options
Diffstat (limited to 'deps/npm/man/man7/semver.7')
| -rw-r--r-- | deps/npm/man/man7/semver.7 | 252 |
1 files changed, 126 insertions, 126 deletions
diff --git a/deps/npm/man/man7/semver.7 b/deps/npm/man/man7/semver.7 index cac3ad617..24ce48b8f 100644 --- a/deps/npm/man/man7/semver.7 +++ b/deps/npm/man/man7/semver.7 @@ -1,4 +1,4 @@ -.TH "SEMVER" "7" "June 2015" "" "" +.TH "SEMVER" "7" "August 2015" "" "" .SH "NAME" \fBsemver\fR \- The semantic versioner for npm .SH Usage @@ -41,64 +41,64 @@ multiple versions to the utility will just sort them\. .RE .SH Versions .P -A "version" is described by the \fBv2\.0\.0\fR specification found at +A "version" is described by the \fBv2\.0\.0\fP specification found at http://semver\.org/\|\. .P -A leading \fB"="\fR or \fB"v"\fR character is stripped off and ignored\. +A leading \fB"="\fP or \fB"v"\fP character is stripped off and ignored\. .SH Ranges .P -A \fBversion range\fR is a set of \fBcomparators\fR which specify versions +A \fBversion range\fP is a set of \fBcomparators\fP which specify versions that satisfy the range\. .P -A \fBcomparator\fR is composed of an \fBoperator\fR and a \fBversion\fR\|\. The set -of primitive \fBoperators\fR is: +A \fBcomparator\fP is composed of an \fBoperator\fP and a \fBversion\fP\|\. The set +of primitive \fBoperators\fP is: .RS 0 .IP \(bu 2 -\fB<\fR Less than +\fB<\fP Less than .IP \(bu 2 -\fB<=\fR Less than or equal to +\fB<=\fP Less than or equal to .IP \(bu 2 -\fB>\fR Greater than +\fB>\fP Greater than .IP \(bu 2 -\fB>=\fR Greater than or equal to +\fB>=\fP Greater than or equal to .IP \(bu 2 -\fB=\fR Equal\. If no operator is specified, then equality is assumed, +\fB=\fP Equal\. If no operator is specified, then equality is assumed, so this operator is optional, but MAY be included\. .RE .P -For example, the comparator \fB>=1\.2\.7\fR would match the versions -\fB1\.2\.7\fR, \fB1\.2\.8\fR, \fB2\.5\.3\fR, and \fB1\.3\.9\fR, but not the versions \fB1\.2\.6\fR -or \fB1\.1\.0\fR\|\. +For example, the comparator \fB>=1\.2\.7\fP would match the versions +\fB1\.2\.7\fP, \fB1\.2\.8\fP, \fB2\.5\.3\fP, and \fB1\.3\.9\fP, but not the versions \fB1\.2\.6\fP +or \fB1\.1\.0\fP\|\. .P -Comparators can be joined by whitespace to form a \fBcomparator set\fR, +Comparators can be joined by whitespace to form a \fBcomparator set\fP, which is satisfied by the \fBintersection\fR of all of the comparators it includes\. .P -A range is composed of one or more comparator sets, joined by \fB||\fR\|\. A +A range is composed of one or more comparator sets, joined by \fB||\fP\|\. A version matches a range if and only if every comparator in at least -one of the \fB||\fR\-separated comparator sets is satisfied by the version\. +one of the \fB||\fP\-separated comparator sets is satisfied by the version\. .P -For example, the range \fB>=1\.2\.7 <1\.3\.0\fR would match the versions -\fB1\.2\.7\fR, \fB1\.2\.8\fR, and \fB1\.2\.99\fR, but not the versions \fB1\.2\.6\fR, \fB1\.3\.0\fR, -or \fB1\.1\.0\fR\|\. +For example, the range \fB>=1\.2\.7 <1\.3\.0\fP would match the versions +\fB1\.2\.7\fP, \fB1\.2\.8\fP, and \fB1\.2\.99\fP, but not the versions \fB1\.2\.6\fP, \fB1\.3\.0\fP, +or \fB1\.1\.0\fP\|\. .P -The range \fB1\.2\.7 || >=1\.2\.9 <2\.0\.0\fR would match the versions \fB1\.2\.7\fR, -\fB1\.2\.9\fR, and \fB1\.4\.6\fR, but not the versions \fB1\.2\.8\fR or \fB2\.0\.0\fR\|\. +The range \fB1\.2\.7 || >=1\.2\.9 <2\.0\.0\fP would match the versions \fB1\.2\.7\fP, +\fB1\.2\.9\fP, and \fB1\.4\.6\fP, but not the versions \fB1\.2\.8\fP or \fB2\.0\.0\fP\|\. .SS Prerelease Tags .P -If a version has a prerelease tag (for example, \fB1\.2\.3\-alpha\.3\fR) then +If a version has a prerelease tag (for example, \fB1\.2\.3\-alpha\.3\fP) then it will only be allowed to satisfy comparator sets if at least one -comparator with the same \fB[major, minor, patch]\fR tuple also has a +comparator with the same \fB[major, minor, patch]\fP tuple also has a prerelease tag\. .P -For example, the range \fB>1\.2\.3\-alpha\.3\fR would be allowed to match the -version \fB1\.2\.3\-alpha\.7\fR, but it would \fInot\fR be satisfied by -\fB3\.4\.5\-alpha\.9\fR, even though \fB3\.4\.5\-alpha\.9\fR is technically "greater -than" \fB1\.2\.3\-alpha\.3\fR according to the SemVer sort rules\. The version -range only accepts prerelease tags on the \fB1\.2\.3\fR version\. The -version \fB3\.4\.5\fR \fIwould\fR satisfy the range, because it does not have a -prerelease flag, and \fB3\.4\.5\fR is greater than \fB1\.2\.3\-alpha\.7\fR\|\. +For example, the range \fB>1\.2\.3\-alpha\.3\fP would be allowed to match the +version \fB1\.2\.3\-alpha\.7\fP, but it would \fInot\fR be satisfied by +\fB3\.4\.5\-alpha\.9\fP, even though \fB3\.4\.5\-alpha\.9\fP is technically "greater +than" \fB1\.2\.3\-alpha\.3\fP according to the SemVer sort rules\. The version +range only accepts prerelease tags on the \fB1\.2\.3\fP version\. The +version \fB3\.4\.5\fP \fIwould\fR satisfy the range, because it does not have a +prerelease flag, and \fB3\.4\.5\fP is greater than \fB1\.2\.3\-alpha\.7\fP\|\. .P The purpose for this behavior is twofold\. First, prerelease versions frequently are updated very quickly, and contain many breaking changes @@ -114,7 +114,7 @@ is still not appropriate to assume that they have opted into taking a similar risk on the \fInext\fR set of prerelease versions\. .SS Prerelease Identifiers .P -The method \fB\|\.inc\fR takes an additional \fBidentifier\fR string argument that +The method \fB\|\.inc\fP takes an additional \fBidentifier\fP string argument that will append the value of the string as a prerelease identifier: .P .RS 2 @@ -147,13 +147,13 @@ Advanced range syntax desugars to primitive comparators in deterministic ways\. .P Advanced ranges may be combined in the same way as primitive -comparators using white space or \fB||\fR\|\. -.SS Hyphen Ranges \fBX\.Y\.Z \- A\.B\.C\fR +comparators using white space or \fB||\fP\|\. +.SS Hyphen Ranges \fBX\.Y\.Z \- A\.B\.C\fP .P Specifies an inclusive set\. .RS 0 .IP \(bu 2 -\fB1\.2\.3 \- 2\.3\.4\fR := \fB>=1\.2\.3 <=2\.3\.4\fR +\fB1\.2\.3 \- 2\.3\.4\fP := \fB>=1\.2\.3 <=2\.3\.4\fP .RE .P @@ -161,7 +161,7 @@ If a partial version is provided as the first version in the inclusive range, then the missing pieces are replaced with zeroes\. .RS 0 .IP \(bu 2 -\fB1\.2 \- 2\.3\.4\fR := \fB>=1\.2\.0 <=2\.3\.4\fR +\fB1\.2 \- 2\.3\.4\fP := \fB>=1\.2\.0 <=2\.3\.4\fP .RE .P @@ -171,22 +171,22 @@ of the tuple are accepted, but nothing that would be greater than the provided tuple parts\. .RS 0 .IP \(bu 2 -\fB1\.2\.3 \- 2\.3\fR := \fB>=1\.2\.3 <2\.4\.0\fR +\fB1\.2\.3 \- 2\.3\fP := \fB>=1\.2\.3 <2\.4\.0\fP .IP \(bu 2 -\fB1\.2\.3 \- 2\fR := \fB>=1\.2\.3 <3\.0\.0\fR +\fB1\.2\.3 \- 2\fP := \fB>=1\.2\.3 <3\.0\.0\fP .RE -.SS X\-Ranges \fB1\.2\.x\fR \fB1\.X\fR \fB1\.2\.*\fR \fB*\fR +.SS X\-Ranges \fB1\.2\.x\fP \fB1\.X\fP \fB1\.2\.*\fP \fB*\fP .P -Any of \fBX\fR, \fBx\fR, or \fB*\fR may be used to "stand in" for one of the -numeric values in the \fB[major, minor, patch]\fR tuple\. +Any of \fBX\fP, \fBx\fP, or \fB*\fP may be used to "stand in" for one of the +numeric values in the \fB[major, minor, patch]\fP tuple\. .RS 0 .IP \(bu 2 -\fB*\fR := \fB>=0\.0\.0\fR (Any version satisfies) +\fB*\fP := \fB>=0\.0\.0\fP (Any version satisfies) .IP \(bu 2 -\fB1\.x\fR := \fB>=1\.0\.0 <2\.0\.0\fR (Matching major version) +\fB1\.x\fP := \fB>=1\.0\.0 <2\.0\.0\fP (Matching major version) .IP \(bu 2 -\fB1\.2\.x\fR := \fB>=1\.2\.0 <1\.3\.0\fR (Matching major and minor versions) +\fB1\.2\.x\fP := \fB>=1\.2\.0 <1\.3\.0\fP (Matching major and minor versions) .RE .P @@ -194,99 +194,99 @@ A partial version range is treated as an X\-Range, so the special character is in fact optional\. .RS 0 .IP \(bu 2 -\fB""\fR (empty string) := \fB*\fR := \fB>=0\.0\.0\fR +\fB""\fP (empty string) := \fB*\fP := \fB>=0\.0\.0\fP .IP \(bu 2 -\fB1\fR := \fB1\.x\.x\fR := \fB>=1\.0\.0 <2\.0\.0\fR +\fB1\fP := \fB1\.x\.x\fP := \fB>=1\.0\.0 <2\.0\.0\fP .IP \(bu 2 -\fB1\.2\fR := \fB1\.2\.x\fR := \fB>=1\.2\.0 <1\.3\.0\fR +\fB1\.2\fP := \fB1\.2\.x\fP := \fB>=1\.2\.0 <1\.3\.0\fP .RE -.SS Tilde Ranges \fB~1\.2\.3\fR \fB~1\.2\fR \fB~1\fR +.SS Tilde Ranges \fB~1\.2\.3\fP \fB~1\.2\fP \fB~1\fP .P Allows patch\-level changes if a minor version is specified on the comparator\. Allows minor\-level changes if not\. .RS 0 .IP \(bu 2 -\fB~1\.2\.3\fR := \fB>=1\.2\.3 <1\.(2+1)\.0\fR := \fB>=1\.2\.3 <1\.3\.0\fR +\fB~1\.2\.3\fP := \fB>=1\.2\.3 <1\.(2+1)\.0\fP := \fB>=1\.2\.3 <1\.3\.0\fP .IP \(bu 2 -\fB~1\.2\fR := \fB>=1\.2\.0 <1\.(2+1)\.0\fR := \fB>=1\.2\.0 <1\.3\.0\fR (Same as \fB1\.2\.x\fR) +\fB~1\.2\fP := \fB>=1\.2\.0 <1\.(2+1)\.0\fP := \fB>=1\.2\.0 <1\.3\.0\fP (Same as \fB1\.2\.x\fP) .IP \(bu 2 -\fB~1\fR := \fB>=1\.0\.0 <(1+1)\.0\.0\fR := \fB>=1\.0\.0 <2\.0\.0\fR (Same as \fB1\.x\fR) +\fB~1\fP := \fB>=1\.0\.0 <(1+1)\.0\.0\fP := \fB>=1\.0\.0 <2\.0\.0\fP (Same as \fB1\.x\fP) .IP \(bu 2 -\fB~0\.2\.3\fR := \fB>=0\.2\.3 <0\.(2+1)\.0\fR := \fB>=0\.2\.3 <0\.3\.0\fR +\fB~0\.2\.3\fP := \fB>=0\.2\.3 <0\.(2+1)\.0\fP := \fB>=0\.2\.3 <0\.3\.0\fP .IP \(bu 2 -\fB~0\.2\fR := \fB>=0\.2\.0 <0\.(2+1)\.0\fR := \fB>=0\.2\.0 <0\.3\.0\fR (Same as \fB0\.2\.x\fR) +\fB~0\.2\fP := \fB>=0\.2\.0 <0\.(2+1)\.0\fP := \fB>=0\.2\.0 <0\.3\.0\fP (Same as \fB0\.2\.x\fP) .IP \(bu 2 -\fB~0\fR := \fB>=0\.0\.0 <(0+1)\.0\.0\fR := \fB>=0\.0\.0 <1\.0\.0\fR (Same as \fB0\.x\fR) +\fB~0\fP := \fB>=0\.0\.0 <(0+1)\.0\.0\fP := \fB>=0\.0\.0 <1\.0\.0\fP (Same as \fB0\.x\fP) .IP \(bu 2 -\fB~1\.2\.3\-beta\.2\fR := \fB>=1\.2\.3\-beta\.2 <1\.3\.0\fR Note that prereleases in -the \fB1\.2\.3\fR version will be allowed, if they are greater than or -equal to \fBbeta\.2\fR\|\. So, \fB1\.2\.3\-beta\.4\fR would be allowed, but -\fB1\.2\.4\-beta\.2\fR would not, because it is a prerelease of a -different \fB[major, minor, patch]\fR tuple\. +\fB~1\.2\.3\-beta\.2\fP := \fB>=1\.2\.3\-beta\.2 <1\.3\.0\fP Note that prereleases in +the \fB1\.2\.3\fP version will be allowed, if they are greater than or +equal to \fBbeta\.2\fP\|\. So, \fB1\.2\.3\-beta\.4\fP would be allowed, but +\fB1\.2\.4\-beta\.2\fP would not, because it is a prerelease of a +different \fB[major, minor, patch]\fP tuple\. .RE -.SS Caret Ranges \fB^1\.2\.3\fR \fB^0\.2\.5\fR \fB^0\.0\.4\fR +.SS Caret Ranges \fB^1\.2\.3\fP \fB^0\.2\.5\fP \fB^0\.0\.4\fP .P Allows changes that do not modify the left\-most non\-zero digit in the -\fB[major, minor, patch]\fR tuple\. In other words, this allows patch and -minor updates for versions \fB1\.0\.0\fR and above, patch updates for -versions \fB0\.X >=0\.1\.0\fR, and \fIno\fR updates for versions \fB0\.0\.X\fR\|\. +\fB[major, minor, patch]\fP tuple\. In other words, this allows patch and +minor updates for versions \fB1\.0\.0\fP and above, patch updates for +versions \fB0\.X >=0\.1\.0\fP, and \fIno\fR updates for versions \fB0\.0\.X\fP\|\. .P -Many authors treat a \fB0\.x\fR version as if the \fBx\fR were the major +Many authors treat a \fB0\.x\fP version as if the \fBx\fP were the major "breaking\-change" indicator\. .P Caret ranges are ideal when an author may make breaking changes -between \fB0\.2\.4\fR and \fB0\.3\.0\fR releases, which is a common practice\. +between \fB0\.2\.4\fP and \fB0\.3\.0\fP releases, which is a common practice\. However, it presumes that there will \fInot\fR be breaking changes between -\fB0\.2\.4\fR and \fB0\.2\.5\fR\|\. It allows for changes that are presumed to be +\fB0\.2\.4\fP and \fB0\.2\.5\fP\|\. It allows for changes that are presumed to be additive (but non\-breaking), according to commonly observed practices\. .RS 0 .IP \(bu 2 -\fB^1\.2\.3\fR := \fB>=1\.2\.3 <2\.0\.0\fR +\fB^1\.2\.3\fP := \fB>=1\.2\.3 <2\.0\.0\fP .IP \(bu 2 -\fB^0\.2\.3\fR := \fB>=0\.2\.3 <0\.3\.0\fR +\fB^0\.2\.3\fP := \fB>=0\.2\.3 <0\.3\.0\fP .IP \(bu 2 -\fB^0\.0\.3\fR := \fB>=0\.0\.3 <0\.0\.4\fR +\fB^0\.0\.3\fP := \fB>=0\.0\.3 <0\.0\.4\fP .IP \(bu 2 -\fB^1\.2\.3\-beta\.2\fR := \fB>=1\.2\.3\-beta\.2 <2\.0\.0\fR Note that prereleases in -the \fB1\.2\.3\fR version will be allowed, if they are greater than or -equal to \fBbeta\.2\fR\|\. So, \fB1\.2\.3\-beta\.4\fR would be allowed, but -\fB1\.2\.4\-beta\.2\fR would not, because it is a prerelease of a -different \fB[major, minor, patch]\fR tuple\. +\fB^1\.2\.3\-beta\.2\fP := \fB>=1\.2\.3\-beta\.2 <2\.0\.0\fP Note that prereleases in +the \fB1\.2\.3\fP version will be allowed, if they are greater than or +equal to \fBbeta\.2\fP\|\. So, \fB1\.2\.3\-beta\.4\fP would be allowed, but +\fB1\.2\.4\-beta\.2\fP would not, because it is a prerelease of a +different \fB[major, minor, patch]\fP tuple\. .IP \(bu 2 -\fB^0\.0\.3\-beta\fR := \fB>=0\.0\.3\-beta <0\.0\.4\fR Note that prereleases in the -\fB0\.0\.3\fR version \fIonly\fR will be allowed, if they are greater than or -equal to \fBbeta\fR\|\. So, \fB0\.0\.3\-pr\.2\fR would be allowed\. +\fB^0\.0\.3\-beta\fP := \fB>=0\.0\.3\-beta <0\.0\.4\fP Note that prereleases in the +\fB0\.0\.3\fP version \fIonly\fR will be allowed, if they are greater than or +equal to \fBbeta\fP\|\. So, \fB0\.0\.3\-pr\.2\fP would be allowed\. .RE .P -When parsing caret ranges, a missing \fBpatch\fR value desugars to the -number \fB0\fR, but will allow flexibility within that value, even if the -major and minor versions are both \fB0\fR\|\. +When parsing caret ranges, a missing \fBpatch\fP value desugars to the +number \fB0\fP, but will allow flexibility within that value, even if the +major and minor versions are both \fB0\fP\|\. .RS 0 .IP \(bu 2 -\fB^1\.2\.x\fR := \fB>=1\.2\.0 <2\.0\.0\fR +\fB^1\.2\.x\fP := \fB>=1\.2\.0 <2\.0\.0\fP .IP \(bu 2 -\fB^0\.0\.x\fR := \fB>=0\.0\.0 <0\.1\.0\fR +\fB^0\.0\.x\fP := \fB>=0\.0\.0 <0\.1\.0\fP .IP \(bu 2 -\fB^0\.0\fR := \fB>=0\.0\.0 <0\.1\.0\fR +\fB^0\.0\fP := \fB>=0\.0\.0 <0\.1\.0\fP .RE .P -A missing \fBminor\fR and \fBpatch\fR values will desugar to zero, but also +A missing \fBminor\fP and \fBpatch\fP values will desugar to zero, but also allow flexibility within those values, even if the major version is zero\. .RS 0 .IP \(bu 2 -\fB^1\.x\fR := \fB>=1\.0\.0 <2\.0\.0\fR +\fB^1\.x\fP := \fB>=1\.0\.0 <2\.0\.0\fP .IP \(bu 2 -\fB^0\.x\fR := \fB>=0\.0\.0 <1\.0\.0\fR +\fB^0\.x\fP := \fB>=0\.0\.0 <1\.0\.0\fP .RE .SH Functions .P -All methods and classes take a final \fBloose\fR boolean argument that, if +All methods and classes take a final \fBloose\fP boolean argument that, if true, will be more forgiving about not\-quite\-valid semver strings\. The resulting output will always be 100% strict, of course\. .P @@ -294,96 +294,96 @@ Strict\-mode Comparators and Ranges will be strict about the SemVer strings that they parse\. .RS 0 .IP \(bu 2 -\fBvalid(v)\fR: Return the parsed version, or null if it's not valid\. +\fBvalid(v)\fP: Return the parsed version, or null if it's not valid\. .IP \(bu 2 -\fBinc(v, release)\fR: Return the version incremented by the release -type (\fBmajor\fR, \fBpremajor\fR, \fBminor\fR, \fBpreminor\fR, \fBpatch\fR, -\fBprepatch\fR, or \fBprerelease\fR), or null if it's not valid +\fBinc(v, release)\fP: Return the version incremented by the release +type (\fBmajor\fP, \fBpremajor\fP, \fBminor\fP, \fBpreminor\fP, \fBpatch\fP, +\fBprepatch\fP, or \fBprerelease\fP), or null if it's not valid .RS 0 .IP \(bu 2 -\fBpremajor\fR in one call will bump the version up to the next major +\fBpremajor\fP in one call will bump the version up to the next major version and down to a prerelease of that major version\. -\fBpreminor\fR, and \fBprepatch\fR work the same way\. +\fBpreminor\fP, and \fBprepatch\fP work the same way\. .IP \(bu 2 -If called from a non\-prerelease version, the \fBprerelease\fR will work the -same as \fBprepatch\fR\|\. It increments the patch version, then makes a +If called from a non\-prerelease version, the \fBprerelease\fP will work the +same as \fBprepatch\fP\|\. It increments the patch version, then makes a prerelease\. If the input version is already a prerelease it simply increments it\. .RE .IP \(bu 2 -\fBmajor(v)\fR: Return the major version number\. +\fBmajor(v)\fP: Return the major version number\. .IP \(bu 2 -\fBminor(v)\fR: Return the minor version number\. +\fBminor(v)\fP: Return the minor version number\. .IP \(bu 2 -\fBpatch(v)\fR: Return the patch version number\. +\fBpatch(v)\fP: Return the patch version number\. .RE .SS Comparison .RS 0 .IP \(bu 2 -\fBgt(v1, v2)\fR: \fBv1 > v2\fR +\fBgt(v1, v2)\fP: \fBv1 > v2\fP .IP \(bu 2 -\fBgte(v1, v2)\fR: \fBv1 >= v2\fR +\fBgte(v1, v2)\fP: \fBv1 >= v2\fP .IP \(bu 2 -\fBlt(v1, v2)\fR: \fBv1 < v2\fR +\fBlt(v1, v2)\fP: \fBv1 < v2\fP .IP \(bu 2 -\fBlte(v1, v2)\fR: \fBv1 <= v2\fR +\fBlte(v1, v2)\fP: \fBv1 <= v2\fP .IP \(bu 2 -\fBeq(v1, v2)\fR: \fBv1 == v2\fR This is true if they're logically equivalent, +\fBeq(v1, v2)\fP: \fBv1 == v2\fP This is true if they're logically equivalent, even if they're not the exact same string\. You already know how to compare strings\. .IP \(bu 2 -\fBneq(v1, v2)\fR: \fBv1 != v2\fR The opposite of \fBeq\fR\|\. +\fBneq(v1, v2)\fP: \fBv1 != v2\fP The opposite of \fBeq\fP\|\. .IP \(bu 2 -\fBcmp(v1, comparator, v2)\fR: Pass in a comparison string, and it'll call -the corresponding function above\. \fB"==="\fR and \fB"!=="\fR do simple +\fBcmp(v1, comparator, v2)\fP: Pass in a comparison string, and it'll call +the corresponding function above\. \fB"==="\fP and \fB"!=="\fP do simple string comparison, but are included for completeness\. Throws if an invalid comparison string is provided\. .IP \(bu 2 -\fBcompare(v1, v2)\fR: Return \fB0\fR if \fBv1 == v2\fR, or \fB1\fR if \fBv1\fR is greater, or \fB\-1\fR if -\fBv2\fR is greater\. Sorts in ascending order if passed to \fBArray\.sort()\fR\|\. +\fBcompare(v1, v2)\fP: Return \fB0\fP if \fBv1 == v2\fP, or \fB1\fP if \fBv1\fP is greater, or \fB\-1\fP if +\fBv2\fP is greater\. Sorts in ascending order if passed to \fBArray\.sort()\fP\|\. .IP \(bu 2 -\fBrcompare(v1, v2)\fR: The reverse of compare\. Sorts an array of versions -in descending order when passed to \fBArray\.sort()\fR\|\. +\fBrcompare(v1, v2)\fP: The reverse of compare\. Sorts an array of versions +in descending order when passed to \fBArray\.sort()\fP\|\. .IP \(bu 2 -\fBdiff(v1, v2)\fR: Returns difference between two versions by the release type -(\fBmajor\fR, \fBpremajor\fR, \fBminor\fR, \fBpreminor\fR, \fBpatch\fR, \fBprepatch\fR, or \fBprerelease\fR), +\fBdiff(v1, v2)\fP: Returns difference between two versions by the release type +(\fBmajor\fP, \fBpremajor\fP, \fBminor\fP, \fBpreminor\fP, \fBpatch\fP, \fBprepatch\fP, or \fBprerelease\fP), or null if the versions are the same\. .RE .SS Ranges .RS 0 .IP \(bu 2 -\fBvalidRange(range)\fR: Return the valid range or null if it's not valid +\fBvalidRange(range)\fP: Return the valid range or null if it's not valid .IP \(bu 2 -\fBsatisfies(version, range)\fR: Return true if the version satisfies the +\fBsatisfies(version, range)\fP: Return true if the version satisfies the range\. .IP \(bu 2 -\fBmaxSatisfying(versions, range)\fR: Return the highest version in the list -that satisfies the range, or \fBnull\fR if none of them do\. +\fBmaxSatisfying(versions, range)\fP: Return the highest version in the list +that satisfies the range, or \fBnull\fP if none of them do\. .IP \(bu 2 -\fBgtr(version, range)\fR: Return \fBtrue\fR if version is greater than all the +\fBgtr(version, range)\fP: Return \fBtrue\fP if version is greater than all the versions possible in the range\. .IP \(bu 2 -\fBltr(version, range)\fR: Return \fBtrue\fR if version is less than all the +\fBltr(version, range)\fP: Return \fBtrue\fP if version is less than all the versions possible in the range\. .IP \(bu 2 -\fBoutside(version, range, hilo)\fR: Return true if the version is outside +\fBoutside(version, range, hilo)\fP: Return true if the version is outside the bounds of the range in either the high or low direction\. The -\fBhilo\fR argument must be either the string \fB\|'>'\fR or \fB\|'<'\fR\|\. (This is -the function called by \fBgtr\fR and \fBltr\fR\|\.) +\fBhilo\fP argument must be either the string \fB\|'>'\fP or \fB\|'<'\fP\|\. (This is +the function called by \fBgtr\fP and \fBltr\fP\|\.) .RE .P Note that, since ranges may be non\-contiguous, a version might not be greater than a range, less than a range, \fIor\fR satisfy a range! For -example, the range \fB1\.2 <1\.2\.9 || >2\.0\.0\fR would have a hole from \fB1\.2\.9\fR -until \fB2\.0\.0\fR, so the version \fB1\.2\.10\fR would not be greater than the -range (because \fB2\.0\.1\fR satisfies, which is higher), nor less than the -range (since \fB1\.2\.8\fR satisfies, which is lower), and it also does not +example, the range \fB1\.2 <1\.2\.9 || >2\.0\.0\fP would have a hole from \fB1\.2\.9\fP +until \fB2\.0\.0\fP, so the version \fB1\.2\.10\fP would not be greater than the +range (because \fB2\.0\.1\fP satisfies, which is higher), nor less than the +range (since \fB1\.2\.8\fP satisfies, which is lower), and it also does not satisfy the range\. .P If you want to know if a version satisfies or does not satisfy a -range, use the \fBsatisfies(version, range)\fR function\. +range, use the \fBsatisfies(version, range)\fP function\. |