Skip to main content

@std/assert@1.0.19
Built and signed on GitHub Actions

Works with
This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score100%
License
MIT
Downloads89,134/wk
Published3 months ago (1.0.19)

Common assertion functions, especially useful for testing

function assertEquals
assertEquals<T>(
actual: T,
expected: T,
msg?: string
): void

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: This function is based on value equality, but for some cases (such as data that can only be read asynchronously or function properties) value equality is not possible to determine. In such cases, reference equality is used instead, which may cause false negatives for objects such as Blobs or Requests.

Examples

Usage

import { assertEquals } from "@std/assert";

assertEquals("world", "world"); // Doesn't throw
assertEquals("hello", "world"); // Throws

Compare Blob objects

import { assertEquals } from "@std/assert";

const bytes1 = await new Blob(["foo"]).bytes();
const bytes2 = await new Blob(["foo"]).bytes();

assertEquals(bytes1, bytes2);

Type Parameters

The type of the values to compare. This is usually inferred.

Parameters

actual: T

The actual value to compare.

expected: T

The expected value to compare.

optional
msg: string

The optional message to display if the assertion fails.

Return Type

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@std/assert

Import symbol

import { assertEquals } from "@std/assert";
or

Import directly with a jsr specifier

import { assertEquals } from "jsr:@std/assert";