keep-a-changelog
Version:
Node package to parse and generate changelogs following the [keepachangelog](https://keepachangelog.com/) format.
28 lines • 927 B
TypeScript
import type { SemVer } from "./types.js";
/**
* Compare two SemVers.
*
* Returns `0` if `version1` equals `version2`, or `1` if `version1` is greater, or `-1` if `version2` is
* greater.
*
* Sorts in ascending order if passed to {@linkcode Array.sort}.
*
* @example Usage
* ```ts
* import { parse, compare } from "@std/semver";
* import { assertEquals } from "@std/assert";
*
* const version1 = parse("1.2.3");
* const version2 = parse("1.2.4");
*
* assertEquals(compare(version1, version2), -1);
* assertEquals(compare(version2, version1), 1);
* assertEquals(compare(version1, version1), 0);
* ```
*
* @param version1 The first SemVer to compare
* @param version2 The second SemVer to compare
* @returns `1` if `version1` is greater, `0` if equal, or `-1` if `version2` is greater
*/
export declare function compare(version1: SemVer, version2: SemVer): 1 | 0 | -1;
//# sourceMappingURL=compare.d.ts.map