@planet-a/affinity-node
Version:
API wrapper for the affinity.co API
60 lines (59 loc) • 2.19 kB
JavaScript
// Copyright 2018-2025 the Deno authors. MIT license.
// This module is browser compatible.
import { equal } from "./equal.js";
import { buildMessage } from "../../internal/1.0.12/build_message.js";
import { diff } from "../../internal/1.0.12/diff.js";
import { diffStr } from "../../internal/1.0.12/diff_str.js";
import { format } from "../../internal/1.0.12/format.js";
import { AssertionError } from "./assertion_error.js";
/**
* Make an assertion that `actual` and `expected` are equal, deeply. If not
* deeply equal, then throw.
*
* Type parameter can be specified to ensure values under comparison have the
* same type.
*
* Note: When comparing `Blob` objects, you should first convert them to
* `Uint8Array` using the `Blob.bytes()` method and then compare their
* contents.
*
* @example Usage
* ```ts ignore
* import { assertEquals } from "@std/assert";
*
* assertEquals("world", "world"); // Doesn't throw
* assertEquals("hello", "world"); // Throws
* ```
* @example Compare `Blob` objects
* ```ts ignore
* import { assertEquals } from "@std/assert";
*
* const bytes1 = await new Blob(["foo"]).bytes();
* const bytes2 = await new Blob(["foo"]).bytes();
*
* assertEquals(bytes1, bytes2);
* ```
*
* @typeParam T The type of the values to compare. This is usually inferred.
* @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 assertEquals(actual, expected, msg) {
if (equal(actual, expected)) {
return;
}
const msgSuffix = msg ? `: ${msg}` : ".";
let message = `Values are not equal${msgSuffix}`;
const actualString = format(actual);
const expectedString = format(expected);
const stringDiff = (typeof actual === "string") &&
(typeof expected === "string");
const diffResult = stringDiff
? diffStr(actual, expected)
: diff(actualString.split("\n"), expectedString.split("\n"));
const diffMsg = buildMessage(diffResult, { stringDiff }, arguments[3])
.join("\n");
message = `${message}\n${diffMsg}`;
throw new AssertionError(message);
}