mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
31 lines
863 B
TypeScript
31 lines
863 B
TypeScript
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
|
|
import { format } from "./_format.ts";
|
|
import { AssertionError } from "./assertion_error.ts";
|
|
|
|
/**
|
|
* Make an assertion that `actual` is greater than or equal to `expected`.
|
|
* If not then throw.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* import { assertGreaterOrEqual } from "https://deno.land/std@$STD_VERSION/assert/assert_greater_or_equal.ts";
|
|
*
|
|
* assertGreaterOrEqual(2, 1); // Doesn't throw
|
|
* assertGreaterOrEqual(1, 1); // Doesn't throw
|
|
* assertGreaterOrEqual(0, 1); // Throws
|
|
* ```
|
|
*/
|
|
export function assertGreaterOrEqual<T>(
|
|
actual: T,
|
|
expected: T,
|
|
msg?: string,
|
|
): void {
|
|
if (actual >= expected) return;
|
|
|
|
const actualString = format(actual);
|
|
const expectedString = format(expected);
|
|
throw new AssertionError(
|
|
msg ?? `Expect ${actualString} >= ${expectedString}`,
|
|
);
|
|
}
|