Web/JavaScript/Reference/Global objects/Symbol/matchAll

The Symbol.matchAll well-known symbol returns an iterator, that yields matches of the regular expression against a string. This function is called by the String.prototype.matchAll() method.

The source for this interactive example is stored in a GitHub repository. If you'd like to contribute to the interactive examples project, please clone https://github.com/mdn/interactive-examples and send us a pull request.

Description

This Symbol is used for String.prototype.matchAll() and specifically in RegExp.prototype[@@matchAll](). The following two examples return same result:

'abc'.matchAll(/a/);

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

This method exists for customizing match behavior within RegExp subclasses.

Property attributes of `Symbol.matchAll`
Writable	no
Enumerable	no
Configurable	no

Examples

Using Symbol.matchAll

let re = /[0-9]+/g;
let str = '2016-01-02|2019-03-07';

const numbers = {
  *[Symbol.matchAll] (str) {
    for (const n of str.matchAll(/[0-9]+/g))
      yield n[0];
  }
};

console.log(Array.from(str.matchAll(numbers)));
//  Array ["2016", "01", "02", "2019", "03", "07"]

See String.prototype.matchAll() and RegExp.prototype[@@matchAll]() for more examples.

Specifications

Specification

ECMAScript (ECMA-262)The definition of 'Symbol.matchAll' in that specification.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile						Server
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet	Node.js
`matchAll`	Chrome Full support 73	Edge Full support 79	Firefox Full support 67	IE No support No	Opera Full support 60	Safari Full support 13	WebView Android Full support 73	Chrome Android Full support 73	Firefox Android Full support 67	Opera Android Full support 52	Safari iOS Full support 13	Samsung Internet Android No support No	nodejs Full support 12.0.0

Legend

Full support: Full support
No support: No support