std/assert/assert_match.ts
Lino Le Van c46143f0ac
chore: update copyright year (#4046)
* chore: update copyright year

* fix

---------

Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-01-02 08:11:32 +11:00

27 lines
750 B
TypeScript

// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
import { AssertionError } from "./assertion_error.ts";
/**
* Make an assertion that `actual` match RegExp `expected`. If not
* then throw.
*
* @example
* ```ts
* import { assertMatch } from "https://deno.land/std@$STD_VERSION/assert/assert_match.ts";
*
* assertMatch("Raptor", RegExp(/Raptor/)); // Doesn't throw
* assertMatch("Denosaurus", RegExp(/Raptor/)); // Throws
* ```
*/
export function assertMatch(
actual: string,
expected: RegExp,
msg?: string,
) {
if (!expected.test(actual)) {
const msgSuffix = msg ? `: ${msg}` : ".";
msg = `Expected actual: "${actual}" to match: "${expected}"${msgSuffix}`;
throw new AssertionError(msg);
}
}