std/assert/assert_less_or_equal.ts
2023-12-07 04:13:38 +11:00

31 lines
842 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 less than or equal to `expected`.
* If not then throw.
*
* @example
* ```ts
* import { assertLessOrEqual } from "https://deno.land/std@$STD_VERSION/assert/assert_less_or_equal.ts";
*
* assertLessOrEqual(1, 2); // Doesn't throw
* assertLessOrEqual(1, 1); // Doesn't throw
* assertLessOrEqual(1, 0); // Throws
* ```
*/
export function assertLessOrEqual<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}`,
);
}