RegExp : Object

constructor

RegExp represents a regular expression that can be used for searching and extracting parts of Strings.

RegExp(pattern : String, [flags : String]) : RegExp

Same as new RegExp(pattern, flags).

Constructors

new RegExp(pattern : String, [flags : String]) : RegExp

Constructs a new RegExp for the specified pattern. See flags for acceptable flag values. RegExps can also be constructed using /pattern/flags syntax.

Example:

// The following are equivalent
var x = /pattern/i;
var y = RegExp('pattern', 'i');
var z = new RegExp('pattern', 'i');

Run

Results:

Spec

Instance Properties

dotAll : Boolean readonly

true if the RegExp was created with the 's' flag. DotAll RegExps will match any character for '.' including new lines ('\r' or '\n') which do not match '.' by default. Another option is to replace '.' with an empty inverted character class match '[^]' for systems that do not support ECMAScript 2018. See also multiline.

Example:

var str = '"a quote\nover multiple lines"';

// The following fails because . does not match \n without the s suffix
console.log(/".*"/.test(str));

// The s suffix allows . to match \n
console.log(/".*"/s.test(str));

// Alternatively, use the empty inverted character class
console.log(/"[^]*"/.test(str));

Run

Results:

ECMAScript 2018 Spec

flags : String readonly

Returns the flags specified when constructing this. Each character in flags represents a different option of the RegExp. 'g' is for global. 'i' is for ignoreCase. 'm' is for multiline. 's' is for dotAll. 'y' is for sticky.

Example:

console.log(/./gim.flags);

Run

Results:

Spec

global : Boolean readonly

true if the RegExp was created with the 'g' flag. Global RegExps will match each place this.source occurs in the string, not just the first match. See also String.matchAll().

Example:

console.log('abcba'.replace(/b/, 'X'));
console.log('abcba'.replace(/b/g, 'X'));

Run

Results:

Spec

ignoreCase : Boolean readonly

true if the RegExp was created with the 'i' flag. IgnoreCase RegExps will do case insensitive matching.

Example:

console.log(/hello/.test('Hello'));
console.log(/hello/i.test('Hello'));

Run

Results:

Spec

lastIndex : Number

The starting index into the string for the next search. If this is sticky, the match must be found starting exactly at lastIndex. lastIndex is automatically set to the found index after a successful match. This property only applies if the RegExp is global or %%#sticky|sticky.

Example:

var regexp = /foo|bar|baz/g;
console.log(regexp.exec('foo bar baz')[0]);
console.log(regexp.lastIndex);
regexp.lastIndex = 5;
console.log(regexp.exec('foo bar baz')[0]);

Run

Results:

Spec

multiline : Boolean readonly

true if the RegExp was created with the 'm' flag. Multiline RegExps will match '^' to the beginning of lines as well as the beginning of the string and match '$' to the end of lines as well as the end of the string. Note that multiline does not affect the '.' character class. See dotAll for more details.

Example:

var str = 'hello\nworld';
console.log(/^world/.test(str));
console.log(/^world/m.test(str));

Run

Results:

Spec

source : String readonly

The pattern of this regular expression.

Example:

var regexp = /(\d\d\d)-(\d\d\d\d)/;
console.log(regexp);
console.log(regexp.source);

Run

Results:

Spec

sticky : Boolean readonly

true if the RegExp was created with the 'y' flag. Sticky RegExps will only look for matches that start exactly at lastIndex. Non-sticky RegExps will try finding a match at all subsequent positions in the string if there's no match at lastIndex.

Example:

var nonSticky = /bar/;
console.log(nonSticky.test('foo bar baz'));

var sticky = /bar/y;
console.log(sticky.test('foo bar baz'));
sticky.lastIndex = 4;
console.log(sticky.test('foo bar baz'));

Run

Results:

Spec

Instance Methods

exec(str : String) : Array<String>

If this matches str, returns a new Array with item 0 equal to the portion of str that matched the regular expression, item 1 equal to the first capturing group in this, item 2 equal to the second capturing group in this, and so on. If this doesn't match str, returns null. See also String.match().

Example:

var regexp = /(\d\d\d)-(\d\d\d\d)/;
var result = regexp.exec('call me: 555-4385');
if (result) {
  console.log(result[0]);
  console.log(result[1]);
  console.log(result[2]);
}

Run

Results:

You can name capture groups by placing ?<name> at the start of the group. The captured values are available on a groups property on the returned array. Note, this is new with ECMAScript 2018.

Example:

var regexp = /(?<areacode>\d\d\d)-(?<number>\d\d\d-\d\d\d\d)/;
var result = regexp.exec('call me: 333-555-4385');
if (result) {
  console.dir(result.groups.areacode);
  console.dir(result[1]);
  console.dir(result.groups.number);
  console.dir(result[2]);
}

Run

Results:

If this is a global RegExp, exec can be called repeatedly to get all matches. Each time it is called, it updates this.lastIndex and begins the search from there. When there are no more matches, returns null. See also String.matchAll().

Example:

var regexp = /(\w+): (\d+)/g;
var res;
while (res = regexp.exec('a: 12, b: 5, d: 6')) {
  console.log(res[1], res[2]);
}

Run

Results:

Spec

test(str : String) : Boolean

Returns true if this matches str.

Example:

var regexp = /(\d\d\d)-(\d\d\d\d)/;
console.log(regexp.test('555-4385'));
console.log(regexp.test('KL5-4385'));

Run

Results:

Spec

home license contribute feedback toggle light/dark mode