Skip to main content
Version: Next

match_regex

Checks if a string partially matches a regular expression.

match_regex(input:string, regex:string) -> bool

Description​

The match_regex function returns true if regex matches a substring of input.

To check whether the full string matches, you can use ^ and $ to signify start and end of the string.

input: string​

The string to partially match.

regex: string​

The regular expression try and match.

The supported regular expression syntax is RE2. In particular, this means that lookahead (?=...) and lookbehind (?<=...) are not supported by match_regex at the moment.

Examples​

Check contains a matching substring​

from {input: "Hello There World"},
  {input: "hi there!"},
  {input: "Good Morning" }
output = input.match_regex("[T|t]here")
{input: "Hello There World", output: true}
{input: "hi there!", output: true}
{input: "Good Morning", output: false}

Check if a string matches fully​

from {input: "example"},
  {input: "Example!"},
  {input: "example?" }
output = input.match_regex("^[E|e]xample[!]?$")
{input: "example", output: true}
{input: "example!", output: true}
{input: "example?", output: false}

See Also​

String Operations