regexp(expression)

Instantiates a regular expression object

Availability

Device + Agent

Parameters

Name Type Description
expression String A regular expression

Returns

Regular expression object

Description

This function compiles a regular expression pattern and returns it as a new regexp object.

Important Because of shortcomings in Squirrel’s regexp, we strongly recommend that you implement regular expressions in your agent code using regexp2() as a drop-in replacement for regexp().

Below are the codes that may be used to construct the pattern-matching expression.

Code Operation
\ Quote the next metacharacter
^ Match the beginning of the string
. Match any character
$ Match the end of the string
| Alternation
(subexp) Grouping (creates a capture)
(?:subexp) No capture grouping (no capture)
[] Character class
* Match zero or more times
+ Match one or more times
? Match once or no match
{n} Match exactly n times
{n,} Match at least n times
{n,m} Match at least n times but no more that m times
\l Next character is lower case
\u Next character is upper case
\a Next character is a letter (a-z, A-Z)
\A Next character is not a letter
\w Next character is alphanumeric (a-z, A-Z, 0-9)
\W Next character is non-alphanumeric
\s Next character is a space
\S Next character is not a space
\d Next character is a digit (0-9)
\D Next character is not a digit
\x Next character is a hexadecimal digit (0-F)
\X Next character is not a hexadeximal digit
\c Next character is a control character
\C Next character is not a control character
\p Next character is a punctuation mark
\P Next character is not a punctuation mark
\b Match a character on a word boundary
\B Match a character not a word boundary
\t Match a tab character
\n Match a newline (NL) or linefeed (LF) character
\r Match a carriage return (CR) character
\f Match a formfeed (FF) character

Example Code

See Also

  • regexp2 — Much-improved regular expression library for agents
  • regexp2.capture() — Finds the first match against the target regular expression and tabulates group captures within the match
  • regexp2.match() — Determines whether the target regular expression matches the whole of the passed string
  • regexp2.search() — Finds the first sub-string within the passed string which matches the target regular expression
  • regexp — Squirrel’s regular expression library
  • regexp.capture() — Finds the first match against the target regular expression and tabulates group captures within the match
  • regexp.match() — Determines whether the target regular expression matches the whole of the passed string
  • regexp.search() — Finds the first sub-string within the passed string which matches the target regular expression

© 2024 KORE Wireless. All rights reserved. Terms of Service, Privacy Policy

Toggle