forked from sindresorhus/semver-diff
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
41 lines (30 loc) · 872 Bytes
/
index.d.ts
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
declare namespace semverDiff {
type Result = 'major' | 'minor' | 'patch' | 'prerelease' | 'build';
}
/**
Get the diff type of two [semver](https://github.com/npm/node-semver) versions: `0.0.1 0.0.2` → `patch`.
@returns The difference type between two semver versions, or `undefined` if they're identical or the second one is lower than the first.
@example
```
import semverDiff = require('semver-diff');
semverDiff('1.1.1', '1.1.2');
//=> 'patch'
semverDiff('0.0.1', '1.0.0');
//=> 'major'
semverDiff('0.0.1', '0.1.0');
//=> 'minor'
semverDiff('0.0.1-foo', '0.0.1-foo.bar');
//=> 'prerelease'
semverDiff('0.1.0', '0.1.0+foo');
//=> 'build'
semverDiff('0.0.1', '0.0.1');
//=> undefined
semverDiff('0.0.2', '0.0.1');
//=> undefined
```
*/
declare function semverDiff(
versionA: string,
versionB: string
): semverDiff.Result | undefined;
export = semverDiff;