Text.replaceWholeText()
Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
The replaceWholeText()
method of the Text
interface
replaces the text of the node and all of its logically adjacent text nodes with the specified text.
The replaced nodes are removed, including the current node, unless it was the recipient of
the replacement text.
Note: In order to achieve a similar effect in modern browsers,
consider using Node.textContent
, Element.innerHTML
,
HTMLElement.innerText
, or CharacterData.replaceData()
.
Syntax
replaceWholeText(content)
Parameters
content
-
The text to replace the nodes with.
Note: The
content
parameter is not optional but can be set to the empty string (""
).
Return value
A Text
node with the replaced string, or null
if the replaces string was ""
.
Note: The returned node is the current node unless the current node is read-only, in which case the returned node is a newly created text node of the same type which has been inserted at the location of the replacement.
Exceptions
NoModificationError
DOMException
-
Thrown if all text nodes being replaced are read-only.
Specifications
This method was originally present in the DOM specification. It has been removed and this feature is no longer on track to become a standard.
Instead, consider using algorithms based on Node.textContent
, Element.innerHTML
,
HTMLElement.innerText
, or CharacterData.replaceData()
.
Browser compatibility
BCD tables only load in the browser
See also
- The
Text
interface it belongs to. -
Node.textContent
,Element.innerHTML
,HTMLElement.innerText
,CharacterData.replaceData()