Function: text.match_regex

Reports whether a string contains a match of a regular expression.

Arguments

Arguments
source

string

The string that will be searched.
regexp

string

The regular expression that is matched. Uses RE2 syntax.

Returns

True if regexp matches a substring in source and false otherwise.

Raised exceptions

Exceptions
TypeError If either source or regexp is not a string.
ValueError If regexp is not UTF-8 encoded or is an invalid regular expression.

Examples

Example 1

# Test match of regular expression; returns `true`
- returnStep:
    return: ${text.match_regex("HelloWorld", "Hello|Goodbye")}

Example 2

# Test match of regular expression; returns `false`
- returnStep:
    return: ${text.match_regex("HelloWorld", "Goodbye")}