RegExp.prototype[@@matchAll]()

The [@@matchAll]() method of a regular expression specifies how String.prototype.matchAll should behave.

Try it

Syntax

regexp[Symbol.matchAll](str)

Parameters

str

A String that is a target of the match.

Return value

An iterable iterator (which is not restartable) of matches. Each match is an array with the same shape as the return value of RegExp.prototype.exec().

Description

This method is called internally in String.prototype.matchAll(). For example, the following two examples return the same result.

'abc'.matchAll(/a/g);

/a/g[Symbol.matchAll]('abc');

Like @@split, @@matchAll starts by using @@species to construct a new regex, thus avoiding mutating the original regexp in any way. lastIndex starts as the original regex's value.

const regexp = /[a-c]/g;
regexp.lastIndex = 1;
const str = 'abc';
Array.from(str.matchAll(regexp), (m) => `${regexp.lastIndex} ${m[0]}`);
// Array [ "1 b", "1 c" ]

The validation that the input is a global regex happens in String.prototype.matchAll(). @@matchAll does not validate the input. If the regex is not global, the returned iterator yields the exec() result once and then returns undefined. If the regexp is global, each time the returned iterator's next() method is called, the regex's exec() is called and the result is yielded.

When the regex is sticky and global, it would still perform sticky matches — i.e. it would fail to match any occurrences beyond the lastIndex.

console.log(Array.from("ab-c".matchAll(/[abc]/gy))); // [ 'a', 'b' ]

If the current match is an empty string, the lastIndex would still be advanced — if the regex has the u flag, it would advance by one Unicode codepoint; otherwise, it advances by one UTF-16 code unit.

console.log(Array.from("😄".matchAll(/(?:)/g))); // [ '', '', '' ]
console.log(Array.from("😄".match(/(?:)/gu))); // [ '', '' ]

This method exists for customizing the behavior of matchAll() in RegExp subclasses.

Examples

Direct call

This method can be used in almost the same way as String.prototype.matchAll(), except for the different value of this and the different order of arguments.

const re = /[0-9]+/g;
const str = '2016-01-02';
const result = re[Symbol.matchAll](str);

console.log(Array.from(result, (x) => x[0]));
// ["2016", "01", "02"]

Using @@matchAll in subclasses

Subclasses of RegExp can override the [@@matchAll]() method to modify the default behavior.

For example, to return an Array instead of an iterator:

class MyRegExp extends RegExp {
  [Symbol.matchAll](str) {
    const result = RegExp.prototype[Symbol.matchAll].call(this, str);
    return result ? Array.from(result) : null;
  }
}

const re = new MyRegExp('([0-9]+)-([0-9]+)-([0-9]+)', 'g');
const str = '2016-01-02|2019-03-07';
const result = str.matchAll(re);
console.log(result[0]); // [ "2016-01-02", "2016", "01", "02" ]
console.log(result[1]); // [ "2019-03-07", "2019", "03", "07" ]

Specifications

Specification
ECMAScript Language Specification
# sec-regexp-prototype-matchall

Browser compatibility

BCD tables only load in the browser

See also