mirror of
https://github.com/denoland/std.git
synced 2024-11-21 20:50:22 +00:00
37 lines
1.2 KiB
TypeScript
37 lines
1.2 KiB
TypeScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
// This module is browser compatible.
|
|
|
|
import { equal } from "./equal.ts";
|
|
import { AssertionError } from "./assertion_error.ts";
|
|
|
|
/**
|
|
* Make an assertion that `actual` and `expected` are not equal, deeply.
|
|
* If not then throw.
|
|
*
|
|
* Type parameter can be specified to ensure values under comparison have the same type.
|
|
*
|
|
* @example Usage
|
|
* ```ts no-eval
|
|
* import { assertNotEquals } from "@std/assert/assert-not-equals";
|
|
*
|
|
* assertNotEquals(1, 2); // Doesn't throw
|
|
* assertNotEquals(1, 1); // Throws
|
|
* ```
|
|
*
|
|
* @typeParam T The type of the values to compare.
|
|
* @param actual The actual value to compare.
|
|
* @param expected The expected value to compare.
|
|
* @param msg The optional message to display if the assertion fails.
|
|
*/
|
|
export function assertNotEquals<T>(actual: T, expected: T, msg?: string) {
|
|
if (!equal(actual, expected)) {
|
|
return;
|
|
}
|
|
const actualString = String(actual);
|
|
const expectedString = String(expected);
|
|
const msgSuffix = msg ? `: ${msg}` : ".";
|
|
throw new AssertionError(
|
|
`Expected actual: ${actualString} not to be: ${expectedString}${msgSuffix}`,
|
|
);
|
|
}
|