assertArrayIncludes | /assert/assert_array_includes.ts | std@0.222.0

Module

std/assert/assert_array_includes.ts>assertArrayIncludes

The Deno Standard Library

denoland/deno_std

Go to Latest

mod.ts (default module)

assertNotStrictEquals

assert_almost_equals.ts

assertAlmostEquals

assert_array_includes.ts

assert_greater_or_equal.ts

assertGreaterOrEqual

assert_greater.ts

assertGreater

assert_instance_of.ts

assert_less_or_equal.ts

assert_not_instance_of.ts

assertNotInstanceOf

assert_not_match.ts

assertNotMatch

assert_not_strict_equals.ts

assertNotStrictEquals

assert_object_match.ts

assertObjectMatch

assert_rejects.ts

assertRejects

assert_strict_equals.ts

assertStrictEquals

assert_string_includes.ts

The Standard Library has been moved to JSR. See the blog post for details.

function assertArrayIncludes

import { assertArrayIncludes } from "https://deno.land/std@0.222.0/assert/assert_array_includes.ts";

assertArrayIncludes<T>(

actual: ArrayLikeArg<T>,

expected: ArrayLikeArg<T>,

msg?: string,

)

Make an assertion that actual includes the expected values. If not then an error will be thrown.

Type parameter can be specified to ensure values under comparison have the same type.

Examples

Example 1

import { assertArrayIncludes } from "https://deno.land/std@0.222.0/assert/assert_array_includes.ts";

assertArrayIncludes([1, 2], [2]); // Doesn't throw
assertArrayIncludes([1, 2], [3]); // Throws

Type Parameters

Parameters

actual: ArrayLikeArg<T>

expected: ArrayLikeArg<T>

optional

msg: string