DOMTokenList.replace()

The replace() method of the DOMTokenList interface replaces an existing token with a new token.

Syntax

tokenList.replace(oldToken,newToken);

Parameters

oldToken
A DOMString representing the token you want to replace.
newToken
A DOMString representing the token you want to replace oldToken with.

Return value

A boolean value — true if the token was replaced successfully, and false if not.

Note: In older browsers, replace() returns void.

Examples

In the following example we retrieve the list of classes set on a <span> element as a DOMTokenList using Element.classList. We then replace a token in the list, and write the list into the <span>'s Node.textContent.

First, the HTML:

<span class="a b c"></span>

Now the JavaScript:

var span = document.querySelector("span");
var classes = span.classList;

var result = classes.replace("c", "z");
console.log(result);

if(result) {
  span.textContent = classes;
} else {
  span.textContent = 'token not replaced successfully';
}

The output looks like this:

Specifications

Specification Status Comment
DOM
The definition of 'replace()' in that specification.
Living Standard Initial definition

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support611749 ?48 Yes
return()'s value is a boolean, not void as it used to be.671861 No54 No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support6161174948 Yes No
return()'s value is a boolean, not void as it used to be.6767186154 No Yes

Document Tags and Contributors

Contributors to this page: chrisdavidmills, fscholz, jpmedley, TrebuhD, ziyunfei, jmsfwk, zbinlin, teoli
Last updated by: chrisdavidmills,