aboutsummaryrefslogtreecommitdiff
path: root/node_modules/semver-diff/index.d.ts
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2022-06-04 08:51:01 +0200
committerMinteck <contact@minteck.org>2022-06-04 08:51:01 +0200
commit383285ecd5292bf9a825e05904955b937de84cc9 (patch)
tree0a53b6f02c1604b078044567c03dc1b6c944c8c2 /node_modules/semver-diff/index.d.ts
downloadequestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.gz
equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.bz2
equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.zip
Initial commit
Diffstat (limited to 'node_modules/semver-diff/index.d.ts')
-rw-r--r--node_modules/semver-diff/index.d.ts58
1 files changed, 58 insertions, 0 deletions
diff --git a/node_modules/semver-diff/index.d.ts b/node_modules/semver-diff/index.d.ts
new file mode 100644
index 0000000..d6f6a42
--- /dev/null
+++ b/node_modules/semver-diff/index.d.ts
@@ -0,0 +1,58 @@
+declare namespace semverDiff {
+ type Result =
+ | 'major'
+ | 'premajor'
+ | 'minor'
+ | 'preminor'
+ | 'patch'
+ | 'prepatch'
+ | '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('1.1.1-foo', '1.1.2');
+//=> 'prepatch'
+
+semverDiff('0.0.1', '1.0.0');
+//=> 'major'
+
+semverDiff('0.0.1-foo', '1.0.0');
+//=> 'premajor'
+
+semverDiff('0.0.1', '0.1.0');
+//=> 'minor'
+
+semverDiff('0.0.1-foo', '0.1.0');
+//=> 'preminor'
+
+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;