Skip to main content
assert.match - assert - Node documentation
function assert.match

Usage in Deno

import assert from "node:assert";
match(
value: string,
regExp: RegExp,
message?: string | Error,
): void

Expects the string input to match the regular expression.

import assert from 'node:assert/strict';

assert.match('I will fail', /pass/);
// AssertionError [ERR_ASSERTION]: The input did not match the regular ...

assert.match(123, /pass/);
// AssertionError [ERR_ASSERTION]: The "string" argument must be of type string.

assert.match('I will pass', /pass/);
// OK

If the values do not match, or if the string argument is of another type than string, an [AssertionError](../.././assert/~/assert.AssertionError) is thrown with a message property set equal to the value of the message parameter. If the message parameter is undefined, a default error message is assigned. If the message parameter is an instance of an Error then it will be thrown instead of the [AssertionError](../.././assert/~/assert.AssertionError).

Parameters

value: string
regExp: RegExp
optional
message: string | Error

Return Type

void