RegExp.prototype[Symbol.split]()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

[Symbol.split]() 方法切割 String 对象为一个其子字符串的数组。

语法

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

参数

str

切割操作的目标字符串

limit 可选

可选。一个为了限制切割数量的特定整数。[Symbol.split]() 防范仍会切割每个匹配正则模式的匹配项,直到切割数量达到该限制数,除非提前切割完字符串。

返回值

包含其子字符串的Array

描述

如果切割器是一个RegExp对象,这个方法就将在 String.prototype.split() 的内部调用。例如,下面的两个方法返回相同结果。

js
"a-b-c".split(/-/);

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

这个方法为自定义 RegExp 子类中的匹配行为而存在。

如果 str 参数不是一个RegExp 对象,String.prototype.split() 就不会调用该方法,也不会创建一个 RegExp 对象。示例

直接调用

这个方法的使用方式和 String.prototype.split() 相同,不同之处是 this 和参数顺序。

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

在子类中使用 [Symbol.split]()

RegExp 的子类可以覆写 [Symbol.split]() 方法来修改默认行为。

js
class MyRegExp extends RegExp {
  [Symbol.split](str, limit) {
    var result = RegExp.prototype[Symbol.split].call(this, str, limit);
    return result.map((x) => "(" + x + ")");
  }
}

var re = new MyRegExp("-");
var str = "2016-01-02";
var result = str.split(re); // String.prototype.split 调用 re[Symbol.split]()。
console.log(result); // ["(2016)", "(01)", "(02)"]

规范

Specification
ECMAScript® 2025 Language Specification
# sec-regexp.prototype-%symbol.split%

浏览器兼容性

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
Node.js
[Symbol.split]

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

参见