Skip to main content

Node

The DOM Node interface is an abstract base class upon which many other DOM API objects are based, thus letting those object types be used similarly and often interchangeably. As an abstract class, there is no such thing as a plain Node object. All objects that implement Node functionality are based on one of its subclasses. Most notable are Document, Element, and DocumentFragment.

MDN Reference

Extends​

Extended by​

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​

ParameterType
typestring
callback| EventListenerOrEventListenerObject | null
options?boolean | AddEventListenerOptions

Returns​

void

Inherited from​

EventTarget.addEventListener

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​

ParameterType
nodeT

Returns​

T

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​

ParameterType
subtree?boolean

Returns​

Node

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​

ParameterType
otherNode

Returns​

number

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​

ParameterType
otherNode | null

Returns​

boolean

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​

ParameterType
eventEvent

Returns​

boolean

Inherited from​

EventTarget.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​

ParameterType
options?GetRootNodeOptions

Returns​

Node

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

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​

ParameterType
nodeT
childNode | null

Returns​

T

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​

ParameterType
namespacestring | null

Returns​

boolean

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​

ParameterType
otherNodeNode | null

Returns​

boolean

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​

ParameterType
otherNodeNode | null

Returns​

boolean

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​

ParameterType
prefixstring | null

Returns​

string | null

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​

ParameterType
namespacestring | null

Returns​

string | null

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

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​

ParameterType
childT

Returns​

T

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​

ParameterType
typestring
callback| EventListenerOrEventListenerObject | null
options?boolean | EventListenerOptions

Returns​

void

Inherited from​

EventTarget.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​

ParameterType
nodeNode
childT

Returns​

T

Properties​

ATTRIBUTE_NODE​

readonly ATTRIBUTE_NODE: 2;

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

CDATA_SECTION_NODE​

readonly CDATA_SECTION_NODE: 4;

node is a CDATASection 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

COMMENT_NODE​

readonly COMMENT_NODE: 8;

node is a Comment node.

DOCUMENT_FRAGMENT_NODE​

readonly DOCUMENT_FRAGMENT_NODE: 11;

node is a DocumentFragment node.

DOCUMENT_NODE​

readonly DOCUMENT_NODE: 9;

node is a document.

DOCUMENT_POSITION_CONTAINED_BY​

readonly DOCUMENT_POSITION_CONTAINED_BY: 16;

Set when other is a descendant of node.

DOCUMENT_POSITION_CONTAINS​

readonly DOCUMENT_POSITION_CONTAINS: 8;

Set when other is an ancestor of node.

DOCUMENT_POSITION_DISCONNECTED​

readonly DOCUMENT_POSITION_DISCONNECTED: 1;

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

DOCUMENT_POSITION_FOLLOWING​

readonly DOCUMENT_POSITION_FOLLOWING: 4;

Set when other is following node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC​

readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;

DOCUMENT_POSITION_PRECEDING​

readonly DOCUMENT_POSITION_PRECEDING: 2;

Set when other is preceding node.

DOCUMENT_TYPE_NODE​

readonly DOCUMENT_TYPE_NODE: 10;

node is a doctype.

ELEMENT_NODE​

readonly ELEMENT_NODE: 1;

node is an element.

ENTITY_NODE​

readonly ENTITY_NODE: 6;

ENTITY_REFERENCE_NODE​

readonly ENTITY_REFERENCE_NODE: 5;

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

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

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

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

nodeName​

readonly nodeName: string;

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

MDN Reference

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

nodeValue​

nodeValue: string | null;

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

MDN Reference

NOTATION_NODE​

readonly NOTATION_NODE: 12;

ownerDocument​

readonly ownerDocument: Document | null;

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

MDN Reference

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

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

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

PROCESSING_INSTRUCTION_NODE​

readonly PROCESSING_INSTRUCTION_NODE: 7;

node is a ProcessingInstruction node.

TEXT_NODE​

readonly TEXT_NODE: 3;

node is a Text node.

textContent​

textContent: string | null;

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

MDN Reference