The replaceAll()
method returns a new string with all matches of a pattern
replaced by a replacement
. The pattern
can be a string or a RegExp
, and the replacement
can be a string or a function to be called for each match.
The original string is left unchanged.
const newStr = str.replaceAll(regexp|substr, newSubstr|function)
when using a `regexp` you have to set the global ("g") flag; otherwise, it will throw a TypeError
: "replaceAll must be called with a global RegExp".
regexp
(pattern)RegExp
object or literal with the global flag. The matches are replaced with newSubstr
or the value returned by the specified function
. A RegExp without the global ("g") flag will throw a TypeError
: "replaceAll must be called with a global RegExp".substr
String
that is to be replaced by newSubstr
. It is treated as a literal string and is not interpreted as a regular expression.newSubstr
(replacement)String
that replaces the substring specified by the specified regexp
or substr
parameter. A number of special replacement patterns are supported; see the "Specifying a string as a parameter" section below.function
(replacement)regexp
or substr
. The arguments supplied to this function are described in the "Specifying a function as a parameter" section below.A new string, with all matches of a pattern replaced by a replacement.
This method does not change the calling String
object. It simply returns a new string.
The replacement string can include the following special replacement patterns:
Pattern | Inserts |
---|---|
$$ | Inserts a "$" . |
$& | Inserts the matched substring. |
$` | Inserts the portion of the string that precedes the matched substring. |
$' | Inserts the portion of the string that follows the matched substring. |
$n | Where n is a positive integer less than 100, inserts the n th parenthesized submatch string, provided the first argument was a RegExp object. Note that this is 1 -indexed. |
You can specify a function as the second parameter. In this case, the function will be invoked after the match has been performed. The function's result (return value) will be used as the replacement string. (Note: The above-mentioned special replacement patterns do not apply in this case.)
Note that the function will be invoked multiple times for each full match to be replaced if the regular expression in the first parameter is global.
The arguments to the function are as follows:
Possible name | Supplied value |
---|---|
match | The matched substring. (Corresponds to $& above.) |
p1, p2, ... | The nth string found by a parenthesized capture group, provided the first argument to replace() was a RegExp object. (Corresponds to $1 , $2 , etc. above.) For example, if /(\a+)(\b+)/ , was given, p1 is the match for \a+ , and p2 for \b+ . |
offset | The offset of the matched substring within the whole string being examined. (For example, if the whole string was 'abcd' , and the matched substring was 'bc' , then this argument will be 1 .) |
string | The whole string being examined. |
(The exact number of arguments depends on whether the first argument is a RegExp
object—and, if so, how many parenthesized submatches it specifies.)
'aabbcc'.replaceAll('b', '.'); // 'aa..cc'
When using a regular expression search value, it must be global. This won't work:
'aabbcc'.replaceAll(/b/, '.'); TypeError: replaceAll must be called with a global RegExp
This will work:
'aabbcc'.replaceAll(/b/g, '.'); "aa..cc"
Specification |
---|
ECMAScript (ECMA-262) The definition of 'String.prototype.replaceAll' in that specification. |
Desktop | ||||||
---|---|---|---|---|---|---|
replaceAll |
85 | 85 | 77 | No | 71 | 13.1 |
Mobile | ||||||
---|---|---|---|---|---|---|
replaceAll |
85 | 85 | 79 | 60 | 13.4 | No |
Server | |
---|---|
replaceAll |
No |
© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://wiki.developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replaceAll