ProcessingInstruction

The ProcessingInstruction interface represents a processing instruction; that is, a Node which embeds an instruction targeting a specific application but that can be ignored by any other applications which don't recognize the instruction.

MDN Reference

Extends

CharacterData.LinkStyle

Accessors

textContent

Get Signature

get textContent(): string;

MDN Reference

Returns

string

Set Signature

set textContent(value): void;

The textContent property of the Node interface represents the text content of the node and its descendants.

MDN Reference

Parameters

Parameter	Type
`value`	`string` \| `null`

Returns

void

The textContent property of the Node interface represents the text content of the node and its descendants.

MDN Reference

Inherited from

CharacterData.textContent

Methods

addEventListener()

addEventListener(
   type, 
   callback, 
   options?
): void;

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

Parameters

Parameter	Type
`type`	`string`
`callback`	\| `EventListenerOrEventListenerObject` \| `null`
`options?`	`boolean` \| `AddEventListenerOptions`

Returns

void

Inherited from

CharacterData.addEventListener

after()

after(...nodes): void;

Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

CharacterData.after

appendChild()

appendChild<T>(node): T;

The appendChild() method of the Node interface adds a node to the end of the list of children of a specified parent node.

MDN Reference

Type Parameters

Type Parameter
`T` extends `Node`

Parameters

Parameter	Type
`node`	`T`

Returns

T

Inherited from

CharacterData.appendChild

appendData()

appendData(data): void;

The appendData() method of the CharacterData interface adds the provided data to the end of the node's current data.

MDN Reference

Parameters

Parameter	Type
`data`	`string`

Returns

void

Inherited from

CharacterData.appendData

before()

before(...nodes): void;

Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

CharacterData.before

cloneNode()

cloneNode(subtree?): Node;

The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in the node is also cloned or not.

MDN Reference

Parameters

Parameter	Type
`subtree?`	`boolean`

Returns

Node

Inherited from

CharacterData.cloneNode

compareDocumentPosition()

compareDocumentPosition(other): number;

The compareDocumentPosition() method of the Node interface reports the position of its argument node relative to the node on which it is called.

MDN Reference

Parameters

Parameter	Type
`other`	`Node`

Returns

number

Inherited from

CharacterData.compareDocumentPosition

contains()

contains(other): boolean;

The contains() method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (childNodes), one of the children's direct children, and so on.

MDN Reference

Parameters

Parameter	Type
`other`	`Node` \| `null`

Returns

boolean

Inherited from

CharacterData.contains

deleteData()

deleteData(offset, count): void;

The deleteData() method of the CharacterData interface removes all or part of the data from this CharacterData node.

MDN Reference

Parameters

Parameter	Type
`offset`	`number`
`count`	`number`

Returns

void

Inherited from

CharacterData.deleteData

dispatchEvent()

dispatchEvent(event): boolean;

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

MDN Reference

Parameters

Parameter	Type
`event`	`Event`

Returns

boolean

Inherited from

CharacterData.dispatchEvent

getRootNode()

getRootNode(options?): Node;

The getRootNode() method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.

MDN Reference

Parameters

Parameter	Type
`options?`	`GetRootNodeOptions`

Returns

Node

Inherited from

CharacterData.getRootNode

hasChildNodes()

hasChildNodes(): boolean;

The hasChildNodes() method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.

MDN Reference

Returns

boolean

Inherited from

CharacterData.hasChildNodes

insertBefore()

insertBefore<T>(node, child): T;

The insertBefore() method of the Node interface inserts a node before a reference node as a child of a specified parent node.

MDN Reference

Type Parameters

Type Parameter
`T` extends `Node`

Parameters

Parameter	Type
`node`	`T`
`child`	`Node` \| `null`

Returns

T

Inherited from

CharacterData.insertBefore

insertData()

insertData(offset, data): void;

The insertData() method of the CharacterData interface inserts the provided data into this CharacterData node's current data, at the provided offset from the start of the existing data. The provided data is spliced into the existing data.

MDN Reference

Parameters

Parameter	Type
`offset`	`number`
`data`	`string`

Returns

void

Inherited from

CharacterData.insertData

isDefaultNamespace()

isDefaultNamespace(namespace): boolean;

The isDefaultNamespace() method of the Node interface accepts a namespace URI as an argument. It returns a boolean value that is true if the namespace is the default namespace on the given node and false if not. The default namespace can be retrieved with Node.lookupNamespaceURI() by passing null as the argument.

MDN Reference

Parameters

Parameter	Type
`namespace`	`string` \| `null`

Returns

boolean

Inherited from

CharacterData.isDefaultNamespace

isEqualNode()

isEqualNode(otherNode): boolean;

The isEqualNode() method of the Node interface tests whether two nodes are equal. Two nodes are equal when they have the same type, defining characteristics (for elements, this would be their ID, number of children, and so forth), its attributes match, and so on. The specific set of data points that must match varies depending on the types of the nodes.

MDN Reference

Parameters

Parameter	Type
`otherNode`	`Node` \| `null`

Returns

boolean

Inherited from

CharacterData.isEqualNode

isSameNode()

isSameNode(otherNode): boolean;

The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).

MDN Reference

Parameters

Parameter	Type
`otherNode`	`Node` \| `null`

Returns

boolean

Inherited from

CharacterData.isSameNode

lookupNamespaceURI()

lookupNamespaceURI(prefix): string | null;

The lookupNamespaceURI() method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and null if not). This method's existence allows Node objects to be passed as a namespace resolver to XPathEvaluator.createExpression() and XPathEvaluator.evaluate().

MDN Reference

Parameters

Parameter	Type
`prefix`	`string` \| `null`

Returns

string | null

Inherited from

CharacterData.lookupNamespaceURI

lookupPrefix()

lookupPrefix(namespace): string | null;

The lookupPrefix() method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and null if not. When multiple prefixes are possible, the first prefix is returned.

MDN Reference

Parameters

Parameter	Type
`namespace`	`string` \| `null`

Returns

string | null

Inherited from

CharacterData.lookupPrefix

normalize()

normalize(): void;

The normalize() method of the Node interface puts the specified node and all of its sub-tree into a normalized form. In a normalized sub-tree, no text nodes in the sub-tree are empty and there are no adjacent text nodes.

MDN Reference

Returns

void

Inherited from

CharacterData.normalize

remove()

remove(): void;

Removes node.

MDN Reference

Returns

void

Inherited from

CharacterData.remove

removeChild()

removeChild<T>(child): T;

The removeChild() method of the Node interface removes a child node from the DOM and returns the removed node.

MDN Reference

Type Parameters

Type Parameter
`T` extends `Node`

Parameters

Parameter	Type
`child`	`T`

Returns

T

Inherited from

CharacterData.removeChild

removeEventListener()

removeEventListener(
   type, 
   callback, 
   options?
): void;

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

MDN Reference

Parameters

Parameter	Type
`type`	`string`
`callback`	\| `EventListenerOrEventListenerObject` \| `null`
`options?`	`boolean` \| `EventListenerOptions`

Returns

void

Inherited from

CharacterData.removeEventListener

replaceChild()

replaceChild<T>(node, child): T;

The replaceChild() method of the Node interface replaces a child node within the given (parent) node.

MDN Reference

Type Parameters

Type Parameter
`T` extends `Node`

Parameters

Parameter	Type
`node`	`Node`
`child`	`T`

Returns

T

Inherited from

CharacterData.replaceChild

replaceData()

replaceData(
   offset, 
   count, 
   data
): void;

The replaceData() method of the CharacterData interface removes a certain number of characters of the existing text in a given CharacterData node and replaces those characters with the text provided.

MDN Reference

Parameters

Parameter	Type
`offset`	`number`
`count`	`number`
`data`	`string`

Returns

void

Inherited from

CharacterData.replaceData

replaceWith()

replaceWith(...nodes): void;

Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference

Parameters

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

CharacterData.replaceWith

substringData()

substringData(offset, count): string;

The substringData() method of the CharacterData interface returns a portion of the existing data, starting at the specified index and extending for a given number of characters afterwards.

MDN Reference

Parameters

Parameter	Type
`offset`	`number`
`count`	`number`

Returns

string

Inherited from

CharacterData.substringData

Properties

ATTRIBUTE_NODE

readonly ATTRIBUTE_NODE: 2;

Inherited from

CharacterData.ATTRIBUTE_NODE

baseURI

readonly baseURI: string;

The read-only baseURI property of the Node interface returns the absolute base URL of the document containing the node.

MDN Reference

Inherited from

CharacterData.baseURI

CDATA_SECTION_NODE

readonly CDATA_SECTION_NODE: 4;

node is a CDATASection node.

Inherited from

CharacterData.CDATA_SECTION_NODE

childNodes

readonly childNodes: NodeListOf<ChildNode>;

The read-only childNodes property of the Node interface returns a live NodeList of child nodes of the given element where the first child node is assigned index 0. Child nodes include elements, text and comments.

MDN Reference

Inherited from

CharacterData.childNodes

COMMENT_NODE

readonly COMMENT_NODE: 8;

node is a Comment node.

Inherited from

CharacterData.COMMENT_NODE

data

data: string;

The data property of the CharacterData interface represent the value of the current object's data.

MDN Reference

Inherited from

CharacterData.data

DOCUMENT_FRAGMENT_NODE

readonly DOCUMENT_FRAGMENT_NODE: 11;

node is a DocumentFragment node.

Inherited from

CharacterData.DOCUMENT_FRAGMENT_NODE

DOCUMENT_NODE

readonly DOCUMENT_NODE: 9;

node is a document.

Inherited from

CharacterData.DOCUMENT_NODE

DOCUMENT_POSITION_CONTAINED_BY

readonly DOCUMENT_POSITION_CONTAINED_BY: 16;

Set when other is a descendant of node.

Inherited from

CharacterData.DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINS

readonly DOCUMENT_POSITION_CONTAINS: 8;

Set when other is an ancestor of node.

Inherited from

CharacterData.DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_DISCONNECTED

readonly DOCUMENT_POSITION_DISCONNECTED: 1;

Set when node and other are not in the same tree.

Inherited from

CharacterData.DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_FOLLOWING

readonly DOCUMENT_POSITION_FOLLOWING: 4;

Set when other is following node.

Inherited from

CharacterData.DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;

Inherited from

CharacterData.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_PRECEDING

readonly DOCUMENT_POSITION_PRECEDING: 2;

Set when other is preceding node.

Inherited from

CharacterData.DOCUMENT_POSITION_PRECEDING

DOCUMENT_TYPE_NODE

readonly DOCUMENT_TYPE_NODE: 10;

node is a doctype.

Inherited from

CharacterData.DOCUMENT_TYPE_NODE

ELEMENT_NODE

readonly ELEMENT_NODE: 1;

node is an element.

Inherited from

CharacterData.ELEMENT_NODE

ENTITY_NODE

readonly ENTITY_NODE: 6;

Inherited from

CharacterData.ENTITY_NODE

ENTITY_REFERENCE_NODE

readonly ENTITY_REFERENCE_NODE: 5;

Inherited from

CharacterData.ENTITY_REFERENCE_NODE

firstChild

readonly firstChild: ChildNode | null;

The read-only firstChild property of the Node interface returns the node's first child in the tree, or null if the node has no children.

MDN Reference

Inherited from

CharacterData.firstChild

isConnected

readonly isConnected: boolean;

The read-only isConnected property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.

MDN Reference

Inherited from

CharacterData.isConnected

lastChild

readonly lastChild: ChildNode | null;

The read-only lastChild property of the Node interface returns the last child of the node, or null if there are no child nodes.

MDN Reference

Inherited from

CharacterData.lastChild

length

readonly length: number;

The read-only CharacterData.length property returns the number of characters in the contained data, as a positive integer.

MDN Reference

Inherited from

CharacterData.length

nextElementSibling

readonly nextElementSibling: Element | null;

Returns the first following sibling that is an element, and null otherwise.

MDN Reference

Inherited from

CharacterData.nextElementSibling

nextSibling

readonly nextSibling: ChildNode | null;

The read-only nextSibling property of the Node interface returns the node immediately following the specified one in their parent's childNodes, or returns null if the specified node is the last child in the parent element.

MDN Reference

Inherited from

CharacterData.nextSibling

nodeName

readonly nodeName: string;

The read-only nodeName property of Node returns the name of the current node as a string.

MDN Reference

Inherited from

CharacterData.nodeName

nodeType

readonly nodeType: number;

The read-only nodeType property of a Node interface is an integer that identifies what the node is. It distinguishes different kinds of nodes from each other, such as elements, text, and comments.

MDN Reference

Inherited from

CharacterData.nodeType

nodeValue

nodeValue: string | null;

The nodeValue property of the Node interface returns or sets the value of the current node.

MDN Reference

Inherited from

CharacterData.nodeValue

NOTATION_NODE

readonly NOTATION_NODE: 12;

Inherited from

CharacterData.NOTATION_NODE

ownerDocument

readonly ownerDocument: Document;

The read-only ownerDocument property of the Node interface returns the top-level document object of the node.

MDN Reference

Inherited from

CharacterData.ownerDocument

parentElement

readonly parentElement: HTMLElement | null;

The read-only parentElement property of Node interface returns the DOM node's parent Element, or null if the node either has no parent, or its parent isn't a DOM Element. Node.parentNode on the other hand returns any kind of parent, regardless of its type.

MDN Reference

Inherited from

CharacterData.parentElement

parentNode

readonly parentNode: ParentNode | null;

The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree.

MDN Reference

Inherited from

CharacterData.parentNode

previousElementSibling

readonly previousElementSibling: Element | null;

Returns the first preceding sibling that is an element, and null otherwise.

MDN Reference

Inherited from

CharacterData.previousElementSibling

previousSibling

readonly previousSibling: ChildNode | null;

The read-only previousSibling property of the Node interface returns the node immediately preceding the specified one in its parent's childNodes list, or null if the specified node is the first in that list.

MDN Reference

Inherited from

CharacterData.previousSibling