assertArrayIncludes

function

function 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.

actual: ArrayLikeArg<T>

The array-like object to search within.

expected: ArrayLikeArg<T>

The values that must be present in actual.

msg?: string

Optional message to display on failure.

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

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

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

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