kotlin-js/js.regexp/RegExp

RegExp

open class RegExp(pattern: String, val flags: String = definedExternally) : StringMatcher, StringMatcherAll, StringReplacer, StringSearcher, StringSplitter, Serializable(source)

MDN Reference

Constructors

RegExp

constructor(pattern: String, flags: String = definedExternally)

constructor(pattern: RegExp)

Types

Companion

object Companion

Properties

dotAll

val dotAll: Boolean

Returns a Boolean value indicating the state of the dotAll flag (s) used with a regular expression. Default is false. Read-only.

flags

val flags: String

Returns a string indicating the flags of the regular expression in question. This field is read-only. The characters in this string are sequenced and concatenated in the following order:

global

val global: Boolean

Returns a Boolean value indicating the state of the global flag (g) used with a regular expression. Default is false. Read-only.

hasIndices

val hasIndices: Boolean

Returns a Boolean value indicating the state of the hasIndices flag (d) used with a regular expression. Default is false. Read-only.

ignoreCase

val ignoreCase: Boolean

Returns a Boolean value indicating the state of the ignoreCase flag (i) used with a regular expression. Default is false. Read-only.

lastIndex

var lastIndex: Int

MDN Reference

multiline

val multiline: Boolean

Returns a Boolean value indicating the state of the multiline flag (m) used with a regular expression. Default is false. Read-only.

source

val source: String

Returns a copy of the text of the regular expression pattern. Read-only. The regExp argument is a Regular expression object. It can be a variable name or a literal.

sticky

val sticky: Boolean

Returns a Boolean value indicating the state of the sticky flag (y) used with a regular expression. Default is false. Read-only.

unicode

val unicode: Boolean

Returns a Boolean value indicating the state of the Unicode flag (u) used with a regular expression. Default is false. Read-only.

unicodeSets

val unicodeSets: Boolean

Returns a Boolean value indicating the state of the unicodeSets flag (v) used with a regular expression. Default is false. Read-only.

Functions

[@@match]

open override fun [@@match](string: String): RegExpMatchArray?

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

[@@matchAll]

open override fun [@@matchAll](string: String): JsIterable<RegExpExecArray>

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

[@@replace]

open override fun [@@replace](string: String, replacer: (substring: String) -> String): String

open override fun [@@replace](string: String, replaceValue: String): String

Replaces text in a string, using this regular expression.

[@@search]

open override fun [@@search](string: String): Int

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

[@@split]

open override fun [@@split](string: String, limit: Int = definedExternally): ReadonlyArray<ERROR CLASS: Symbol not found for JsString>

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

exec

fun exec(string: String): RegExpExecArray?

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

test

fun test(string: String): Boolean

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