UNPKG

@pearnaly/semantic-version

Version:

Javascript/Typescript class to represent, parse and compare semantic versions according to semver.org

github.com/pearnaly/semantic-version

pearnaly/semantic-version

96 lines (95 loc) • 4.47 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/** * Result of a comparison of two versions (-1/0/1) */ export declare enum ComparisonResult { Lower = -1, Equal = 0, Greater = 1 } /** * Represents a Semantic Version as described in [https://semver.org](semver.org) */ export declare class SemVersion { readonly strVersion: string; readonly isValid: boolean; readonly major: number; readonly minor: number; readonly patch: number; readonly preReleaseIdentifiers: string[]; readonly buildMetadataIdentifiers: string[]; private static readonly REGEX; constructor(strVersion: string); /** * Compare the two provided versions. * -1 if version1 < version2 * 0 if version1 == version2 * 1 if version1 > version2 * @param version1 first version to compare - as instance of SemVersion or string * @param version2 second version to compare - as instance of SemVersion or string */ static compare(version1: SemVersion | string, version2: SemVersion | string): ComparisonResult; /** * Greater than? true if the first version is strictly greater (>) than the second * @param version1 first version to compare - as instance of SemVersion or string * @param version2 second version to compare - as instance of SemVersion or string */ static gt(version1: SemVersion | string, version2: SemVersion | string): boolean; /** * Greater or equal? true if the first version is greater than or equal to (>=) the second * @param version1 first version to compare - as instance of SemVersion or string * @param version2 second version to compare - as instance of SemVersion or string */ static ge(version1: SemVersion | string, version2: SemVersion | string): boolean; /** * Lower than? true if the first version is strictly lower (<) than the second * @param version1 first version to compare - as instance of SemVersion or string * @param version2 second version to compare - as instance of SemVersion or string */ static lt(version1: SemVersion | string, version2: SemVersion | string): boolean; /** * Lower or equal? true if the first version is lower than or equal to (<=) the second * @param version1 first version to compare - as instance of SemVersion or string * @param version2 second version to compare - as instance of SemVersion or string */ static le(version1: SemVersion | string, version2: SemVersion | string): boolean; /** * equal? true if the first version is equal to (==) the second * @param version1 first version to compare - as instance of SemVersion or string * @param version2 second version to compare - as instance of SemVersion or string */ static eq(version1: SemVersion | string, version2: SemVersion | string): boolean; /** * Compare this version to the provided one * -1 if this < comparison * 0 if this == comparison * 1 if this > comparison * @param comparison second version to compare - as instance of SemVersion or string */ compareTo(comparison: SemVersion | string): ComparisonResult; /** * Greater than? true if this version is strictly greater (>) than the compared one * @param comparison second version to compare - as instance of SemVersion or string */ gt(comparison: SemVersion | string): boolean; /** * Greater or equal? true if this version is greater than or equal to (>=) the compared one * @param comparison second version to compare - as instance of SemVersion or string */ ge(comparison: SemVersion | string): boolean; /** * Lower than? true this version is strictly lower (<) than the compared one * @param comparison second version to compare - as instance of SemVersion or string */ lt(comparison: SemVersion | string): boolean; /** * Lower or equal? true this version is lower than or equal to (<=) the compared one * @param comparison second version to compare - as instance of SemVersion or string */ le(comparison: SemVersion | string): boolean; /** * equal? true if this version is equal to (==) the compared one * @param comparison second version to compare - as instance of SemVersion or string */ eq(comparison: SemVersion | string): boolean; toString(): string; }