mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
28 lines
774 B
TypeScript
28 lines
774 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
|
|
* ```ts
|
|
* import { assertStringIncludes } from "@std/assert/assert-string-includes";
|
|
*
|
|
* 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);
|
|
}
|
|
}
|