mirror of
https://github.com/denoland/std.git
synced 2024-11-21 20:50:22 +00:00
31 lines
966 B
TypeScript
31 lines
966 B
TypeScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
// This module is browser compatible.
|
|
import type { SemVer } from "./types.ts";
|
|
import { compare } from "./compare.ts";
|
|
|
|
/**
|
|
* Less than or equal to comparison for two SemVers.
|
|
*
|
|
* This is equal to `compare(version1, version2) <= 0`.
|
|
*
|
|
* @example Usage
|
|
* ```ts
|
|
* import { parse, lessOrEqual } from "@std/semver";
|
|
* import { assert } from "@std/assert";
|
|
*
|
|
* const version1 = parse("1.2.3");
|
|
* const version2 = parse("1.2.4");
|
|
*
|
|
* assert(lessOrEqual(version1, version2));
|
|
* assert(!lessOrEqual(version2, version1));
|
|
* assert(lessOrEqual(version1, version1));
|
|
* ```
|
|
*
|
|
* @param version1 the first version to compare
|
|
* @param version2 the second version to compare
|
|
* @returns `true` if `version1` is less than or equal to `version2`, `false` otherwise
|
|
*/
|
|
export function lessOrEqual(version1: SemVer, version2: SemVer): boolean {
|
|
return compare(version1, version2) <= 0;
|
|
}
|