Skip to main content
Module

std/assert/assert_string_includes.ts

The Deno Standard Library
Go to Latest
File
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.// This module is browser compatible.import { AssertionError } from "./assertion_error.ts";
/** * Make an assertion that actual includes expected. If not * then throw. * * @example * ```ts * import { assertStringIncludes } from "https://deno.land/std@$STD_VERSION/assert/assert_string_includes.ts"; * * assertStringIncludes("Hello", "ello"); // Doesn't throw * assertStringIncludes("Hello", "world"); // Throws * ``` */export function assertStringIncludes( actual: string, expected: string, msg?: string,) { if (!actual.includes(expected)) { const msgSuffix = msg ? `: ${msg}` : "."; msg = `Expected actual: "${actual}" to contain: "${expected}"${msgSuffix}`; throw new AssertionError(msg); }}