mirror of
https://github.com/denoland/std.git
synced 2024-11-21 20:50:22 +00:00
5803cc9172
* BREAKING(assert): remove `assert` from module names * work * fix * work * work * tweaks * fix
31 lines
955 B
TypeScript
31 lines
955 B
TypeScript
// 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 Usage
|
|
* ```ts no-eval
|
|
* import { assertStringIncludes } from "@std/assert";
|
|
*
|
|
* assertStringIncludes("Hello", "ello"); // Doesn't throw
|
|
* assertStringIncludes("Hello", "world"); // Throws
|
|
* ```
|
|
*
|
|
* @param actual The actual string to check for inclusion.
|
|
* @param expected The expected string to check for inclusion.
|
|
* @param msg The optional message to display if the assertion fails.
|
|
*/
|
|
export function assertStringIncludes(
|
|
actual: string,
|
|
expected: string,
|
|
msg?: string,
|
|
) {
|
|
if (actual.includes(expected)) return;
|
|
const msgSuffix = msg ? `: ${msg}` : ".";
|
|
msg = `Expected actual: "${actual}" to contain: "${expected}"${msgSuffix}`;
|
|
throw new AssertionError(msg);
|
|
}
|