RegExp.prototype[@@split]()

The [@@split]() method of a regular expression specifies how String.prototype.split should behave when the regular expression is passed in as the separator.

Try it

Syntax

regexp[Symbol.split](str[, limit])

Parameters

str

The target of the split operation.

limit Optional

Integer specifying a limit on the number of splits to be found. The [@@split]() method still splits on every match of this RegExp pattern (or, in the Syntax above, regexp), until the number of split items match the limit or the string falls short of this pattern.

Return value

An Array containing substrings as its elements. Capturing groups are included.

Description

This method is called internally in String.prototype.split() when a RegExp is passed as the separator. For example, the following two examples return the same result.

'a-b-c'.split(/-/);

/-/[Symbol.split]('a-b-c');

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

The RegExp.prototype[@@split]() base method exhibits the following behaviors:

  • The regexp's g ("global") flag is ignored, and the y ("sticky") flag is always applied even when it was not originally present.
  • If the target string is empty, and the regexp can match empty strings (for example, /a?/), an empty array is returned. Otherwise, if the regexp can't match an empty string, [""] is returned.
  • The matching proceeds by continuously calling this.exec(). Since the regexp is always sticky, this will move along the string, each time yielding a matching string, index, and any capturing groups.
  • For each match, the substring between the last matched string's end and the current matched string's beginning is first appended to the result array. Then, the capturing groups' values are appended one-by-one.
  • If the regexp doesn't match the target string, the target string is returned as-is, wrapped in an array.
  • The returned array's length will never exceed the limit parameter, if provided, while trying to be as close as possible. Therefore, the last match and its capturing groups may not all be present in the returned array if the array is already filled.

Examples

Direct call

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

const re = /-/g;
const str = '2016-01-02';
const result = re[Symbol.split](str);
console.log(result);  // ["2016", "01", "02"]

Using @@split in subclasses

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

class MyRegExp extends RegExp {
  [Symbol.split](str, limit) {
    const result = RegExp.prototype[Symbol.split].call(this, str, limit);
    return result.map((x) => `(${x})`);
  }
}

const re = new MyRegExp('-');
const str = '2016-01-02';
const result = str.split(re); // String.prototype.split calls re[@@split].
console.log(result); // ["(2016)", "(01)", "(02)"]

Specifications

Specification
ECMAScript Language Specification
# sec-regexp.prototype-@@split

Browser compatibility

BCD tables only load in the browser

See also