Web/JavaScript/Reference/Global objects/Symbol/match

From Get docs


The Symbol.match well-known symbol specifies the matching of a regular expression against a string. This function is called by the String.prototype.match() 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 function is also used to identify if objects have the behavior of regular expressions. For example, the methods String.prototype.startsWith(), String.prototype.endsWith() and String.prototype.includes(), check if their first argument is a regular expression and will throw a TypeError if they are. Now, if the match symbol is set to false (or a Falsy value), it indicates that the object is not intended to be used as a regular expression object.

Property attributes of Symbol.match
Writable no
Enumerable no
Configurable no

Examples

Disabling the isRegExp check

The following code will throw a TypeError: 

'/bar/'.startsWith(/bar/); 

// Throws TypeError, as /bar/ is a regular expression
// and Symbol.match is not modified.

However, if you set Symbol.match to false, the isRegExp check (that uses the match property) will indicate that the object is not a regular expression object. The methods startsWith and endsWith won't throw a TypeError as a consequence. 

var re = /foo/;
re[Symbol.match] = false;
'/foo/'.startsWith(re); // true
'/baz/'.endsWith(re);   // false

Specifications

Specification
ECMAScript (ECMA-262)The definition of 'Symbol.match' 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
match Chrome

Full support 50

Edge

Full support 79

Firefox

Full support 40

IE

No support No

Opera

Full support 37

Safari

Full support 10

WebView Android

Full support 50

Chrome Android

Full support 50

Firefox Android

Full support 40

Opera Android

Full support 37

Safari iOS

Full support 10

Samsung Internet Android

Full support 5.0

nodejs

Full support 6.0.0

Legend

Full support  
Full support
No support  
No support


See also

Retrieved from "https://getdocs.org/index.php?title=Web/JavaScript/Reference/Global_objects/Symbol/match&oldid=28304"
Powered by MediaWiki