在此页

• 句法
• 描述
• 范例
• 规范
• 浏览器兼容性
• 另请参阅
• 相关话题

[@@replace]() method replaces some or all matches of a this pattern in a string by a replacement , and returns the result of the replacement as a new string. The replacement can be a string or a function to be called for each match.

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.

句法

regexp[Symbol.replace](str, newSubStr|function)
					

参数

str

String that is a target of the replacement.

newSubStr (replacement)

String that replaces the substring. A number of special replacement patterns are supported; see the Specifying a string as a parameter section in String.prototype.replace() 页面。

function (replacement)

A function to be invoked to create the new substring. The arguments supplied to this function are described in the Specifying a function as a parameter section in String.prototype.replace() 页面。

返回值

A new string with some or all matches of a pattern replaced by a replacement.

描述

This method is called internally in String.prototype.replace() 若 pattern argument is a RegExp object.  For example, following two examples return same result.

'abc'.replace(/a/, 'A');
/a/[Symbol.replace]('abc', 'A');
					

This method exists for customizing replace behavior in RegExp subclass.

If pattern argument is not a RegExp 对象， String.prototype.replace() doesn't call this method, nor creates a RegExp 对象。

范例

Direct call

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

var re = /-/g;
var str = '2016-01-01';
var newstr = re[Symbol.replace](str, '.');
console.log(newstr);  // 2016.01.01
					

Using @@replace in subclasses

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

class MyRegExp extends RegExp {
  constructor(pattern, flags, count) {
    super(pattern, flags);
    this.count = count;
  }
  [Symbol.replace](str, replacement) {
    // Perform @@replace |count| times.
    var result = str;
    for (var i = 0; i < this.count; i++) {
      result = RegExp.prototype[Symbol.replace].call(this, result, replacement);
    }
    return result;
  }
}
var re = new MyRegExp('\\d', '', 3);
var str = '01234567';
var newstr = str.replace(re, '#'); // String.prototype.replace calls re[@@replace].
console.log(newstr); // ###34567
					

规范

规范
ECMAScript (ECMA-262) The definition of 'RegExp.prototype[@@replace]' in that specification.

浏览器兼容性

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request. 更新 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
@@replace	Chrome 50	Edge 79	Firefox 49	IE No	Opera 37	Safari 10	WebView Android 50	Chrome Android 50	Firefox Android 49	Opera Android 37	Safari iOS 10	Samsung Internet Android 5.0	nodejs 6.0.0

图例

完整支持

完整支持

不支持

不支持

另请参阅

• String.prototype.replace()
• RegExp.prototype[@@match]()
• RegExp.prototype[@@search]()
• RegExp.prototype[@@split]()
• RegExp.prototype.exec()
• RegExp.prototype.test()

元数据

• 最后修改： 2020 年 1 月 22 日

相关话题

1. 标准内置对象
2. RegExp
3. 特性
   1. RegExp.$1-$9
   2. RegExp.input ($_)
   3. RegExp.lastMatch ($&)
   4. RegExp.lastParen ($+)
   5. RegExp.leftContext ($`)
   6. RegExp.prototype.dotAll
   7. RegExp.prototype.flags
   8. RegExp.prototype.global
   9. RegExp.prototype.ignoreCase
   10. RegExp.prototype.multiline
   11. RegExp.prototype.source
   12. RegExp.prototype.sticky
   13. RegExp.prototype.unicode
   14. RegExp.rightContext ($')
   15. RegExpInstance.lastIndex
   16. get RegExp[@@species]
4. 方法
   1. RegExp.prototype.compile()
   2. RegExp.prototype.exec()
   3. RegExp.prototype.test()
   4. RegExp.prototype.toSource()
   5. RegExp.prototype.toString()
   6. RegExp.prototype[@@matchAll]()
   7. RegExp.prototype[@@match]()
   8. RegExp.prototype[@@replace]()
   9. RegExp.prototype[@@search]()
   10. RegExp.prototype[@@split]()
5. 继承：
6. Function
7. 特性
   1. Function.arguments
   2. Function.caller
   3. Function.displayName
   4. Function.length
   5. Function.name
8. 方法
   1. Function.prototype.apply()
   2. Function.prototype.bind()
   3. Function.prototype.call()
   4. Function.prototype.toSource()
   5. Function.prototype.toString()
9. Object
10. 特性
    1. Object.prototype.__proto__
    2. Object.prototype.constructor
11. 方法
    1. Object.prototype.__defineGetter__()
    2. Object.prototype.__defineSetter__()
    3. Object.prototype.__lookupGetter__()
    4. Object.prototype.__lookupSetter__()
    5. Object.prototype.hasOwnProperty()
    6. Object.prototype.isPrototypeOf()
    7. Object.prototype.propertyIsEnumerable()
    8. Object.prototype.toLocaleString()
    9. Object.prototype.toSource()
    10. Object.prototype.toString()
    11. Object.prototype.valueOf()
    12. Object.setPrototypeOf()