Interface RegExp

Readonly dotAll

Readonly flags

Readonly global

Readonly hasIndices

Readonly ignoreCase

lastIndex

Readonly multiline

Readonly source

Readonly sticky

Readonly unicode

[matchAll]

• [matchAll](str): IterableIterator<RegExpMatchArray>

• Matches a string with this regular expression, and returns an iterable of matches containing the results of that search.

  Parameters

  • str: string

  Returns IterableIterator<RegExpMatchArray>

[match]

• [match](string): RegExpMatchArray

• Matches a string with this regular expression, and returns an array containing the results of that search.

  Parameters

  • string: string

    A string to search within.

  Returns RegExpMatchArray

[replace]

• [replace](string, replaceValue): string

• Replaces text in a string, using this regular expression.

  Parameters

  • string: string

    A String object or string literal whose contents matching against this regular expression will be replaced

  • replaceValue: string

    A String object or string literal containing the text to replace for every successful match of this regular expression.

  Returns string
• [replace](string, replacer): string

• Replaces text in a string, using this regular expression.

  Parameters

  • string: string

    A String object or string literal whose contents matching against this regular expression will be replaced

  • replacer: ((substring, ...args) => string)

    A function that returns the replacement text.

    • • (substring, ...args): string

      • Parameters

        • substring: string

        • Rest ...args: any[]

        Returns string

  Returns string

[search]

• [search](string): number

• Finds the position beginning first substring match in a regular expression search using this regular expression.

  Parameters

  • string: string

    The string to search within.

  Returns number

[split]

• [split](string, limit?): string[]

• Returns an array of substrings that were delimited by strings in the original input that match against this regular expression.

  If the regular expression contains capturing parentheses, then each time this regular expression matches, the results (including any undefined results) of the capturing parentheses are spliced.

  Parameters

  • string: string

    string value to split

  • Optional limit: number

    if not undefined, the output array is truncated so that it contains no more than 'limit' elements.

  Returns string[]

compile

• compile(pattern, flags?): RegExp

• Parameters

  • pattern: string

  • Optional flags: string

  Returns RegExp

  Deprecated

  A legacy feature for browser compatibility

exec

• exec(string): RegExpExecArray

• Executes a search on a string using a regular expression pattern, and returns an array containing the results of that search.

  Parameters

  • string: string

    The String object or string literal on which to perform the search.

  Returns RegExpExecArray

test

• test(string): boolean

• Returns a Boolean value that indicates whether or not a pattern exists in a searched string.

  Parameters

  • string: string

    String on which to perform the search.

  Returns boolean