RegExp.prototype[@@match]()
The [@@match]()
method retrieves the matches when matching a string against a regular expression.
Syntax
<var>regexp</var>[Symbol.match](str)
Parameters
str
- A
String
that is a target of the match.
Return value
An Array
containing the entire match result and any parentheses-captured matched results, or null
if there were no matches.
Description
This method is called internally in String.prototype.match()
. For example, the following two examples return same result.
'abc'.match(/a/); /a/[Symbol.match]('abc');
This method exists for customizing match behavior within RegExp
subclasses.
Examples
Direct call
This method can be used in almost the same way as String.prototype.match()
, except the different this
and the different arguments order.
var re = /[0-9]+/g; var str = '2016-01-02'; var result = re[Symbol.match](str); console.log(result); // ["2016", "01", "02"]
Using @@match
in subclasses
Subclasses of RegExp
can override the [@@match]()
method to modify the default behavior.
class MyRegExp extends RegExp { [Symbol.match](str) { var result = RegExp.prototype[Symbol.match].call(this, str); if (!result) return null; return { group(n) { return result[n]; } }; } } var re = new MyRegExp('([0-9]+)-([0-9]+)-([0-9]+)'); var str = '2016-01-02'; var result = str.match(re); // String.prototype.match calls re[@@match]. console.log(result.group(1)); // 2016 console.log(result.group(2)); // 01 console.log(result.group(3)); // 02
Specifications
Specification | Status | Comment |
---|---|---|
ECMAScript 2015 (6th Edition, ECMA-262) The definition of 'RegExp.prototype[@@match]' in that specification. |
Standard | Initial defintion. |
ECMAScript 2017 Draft (ECMA-262) The definition of 'RegExp.prototype[@@match]' in that specification. |
Draft |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | (Yes) | 49 (49) | No support | (Yes) | (Yes) |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | (Yes) | (Yes) | 49.0 (49) | No support | (Yes) | (Yes) |
See also
String.prototype.match()
RegExp.prototype[@@replace]()
RegExp.prototype[@@search]()
RegExp.prototype[@@split]()
RegExp.prototype.exec()
RegExp.prototype.test()
License
© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/javascript/reference/global_objects/regexp/@@match