{"route":"/en-US-v0.13.1/reference/foundations/regex/","title":"Regex","description":"Documentation for the Regex type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"constructor","name":"Constructor","children":[{"id":"constructor-regex","name":"regex","children":[]}]}],"body":{"kind":"type","content":{"name":"regex","title":"Regex","keywords":[],"oneliner":"A regular expression.","details":"

A regular expression.

\n

Can be used as a show rule selector and with\nstring methods like find, split, and replace.

\n

See here for a specification\nof the supported syntax.

\n

Example

\n
// Works with string methods.\n#"a,b;c".split(regex("[,;]"))\n\n// Works with show rules.\n#show regex("\\d+"): set text(red)\n\nThe numbers 1 to 10.\n
\"Preview\"
","constructor":{"path":[],"name":"regex","title":"Construct","keywords":[],"oneliner":"Create a regular expression from a string.","element":false,"contextual":false,"deprecation":null,"details":"

Create a regular expression from a string.

","example":null,"self":false,"params":[{"name":"regex","details":"

The regular expression as a string.

\n

Most regex escape sequences just work because they are not valid Typst\nescape sequences. To produce regex escape sequences that are also valid in\nTypst (e.g. \\\\), you need to escape twice. Thus, to match a verbatim\nbackslash, you would need to write regex("\\\\\\\\").

\n

If you need many escape sequences, you can also create a raw element\nand extract its text to use it for your regular expressions:

","example":"

regex(`\\d+\\.\\d+\\.\\d+`.text).

","types":["str"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["regex"],"scope":[]},"scope":[]}}}