yeet:assert
yeet:assert exports functions that each throw an AssertionError when a value is not what you expected.
import { assertEquals } from "yeet:assert";
yeet.test("adds", () => assertEquals(1 + 1, 2));
Importing
import { assert, assertEquals, assertStrictEquals, AssertionError } from "yeet:assert";
| Export | Kind | Description |
|---|---|---|
assert | function | Fails if a value is falsy |
assertEquals | function | Fails unless two values are deeply equal |
assertStrictEquals | function | Fails unless two values are the same value |
AssertionError | class | What each assertion throws |
F assert
assert(expr: unknown, msg?: string): void
Throws an AssertionError with msg if expr is falsy.
F assertEquals
assertEquals(actual: unknown, expected: unknown, msg?: string): void
Throws an AssertionError unless actual and expected are deeply equal. The message shows both values. Objects must have the same constructor and equal own enumerable properties. NaN equals NaN, dates compare by time, and a Map or Set ignores the order of its entries.
F assertStrictEquals
assertStrictEquals(actual: unknown, expected: unknown, msg?: string): void
Throws an AssertionError unless Object.is(actual, expected).
O AssertionError
class AssertionError extends Error {
name: "AssertionError";
}