assertArrayIncludes - @std/assert

function assertArrayIncludes

assertArrayIncludes<T>(actual: ArrayLikeArg<T>,
expected: ArrayLikeArg<T>,
msg?: string
): void

Asserts that actual contains all values in expected, using deep equality for non-primitive values.

Examples

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

assertArrayIncludes([1, 2, 3], [2, 3]); // Passes
assertArrayIncludes([1, 2, 3], [4]); // Throws

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

assertArrayIncludes([{ a: 1 }, { b: 2 }], [{ a: 1 }]); // Passes

T

The element type of the arrays.

actual: ArrayLikeArg<T>

The array-like object to search within.

expected: ArrayLikeArg<T>

The values that must be present in actual.

optional

msg: string

Optional message to display on failure.

void

AssertionError

If any value in expected is not found in actual.