Interface 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.

interface Node {
    ATTRIBUTE_NODE: 2;
    baseURI: string;
    CDATA_SECTION_NODE: 4;
    childNodes: NodeListOf<ChildNode>;
    COMMENT_NODE: 8;
    DOCUMENT_FRAGMENT_NODE: 11;
    DOCUMENT_NODE: 9;
    DOCUMENT_POSITION_CONTAINED_BY: 16;
    DOCUMENT_POSITION_CONTAINS: 8;
    DOCUMENT_POSITION_DISCONNECTED: 1;
    DOCUMENT_POSITION_FOLLOWING: 4;
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
    DOCUMENT_POSITION_PRECEDING: 2;
    DOCUMENT_TYPE_NODE: 10;
    ELEMENT_NODE: 1;
    ENTITY_NODE: 6;
    ENTITY_REFERENCE_NODE: 5;
    firstChild: ChildNode;
    isConnected: boolean;
    lastChild: ChildNode;
    nextSibling: ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: string;
    NOTATION_NODE: 12;
    ownerDocument: Document;
    parentElement: HTMLElement;
    parentNode: ParentNode;
    previousSibling: ChildNode;
    PROCESSING_INSTRUCTION_NODE: 7;
    TEXT_NODE: 3;
    textContent: string;
    addEventListener(
        type: string,
        callback: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    appendChild<T extends Node>(node: T): T;
    cloneNode(subtree?: boolean): Node;
    compareDocumentPosition(other: Node): number;
    contains(other: Node): boolean;
    dispatchEvent(event: Event): boolean;
    getRootNode(options?: GetRootNodeOptions): Node;
    hasChildNodes(): boolean;
    insertBefore<T extends Node>(node: T, child: Node): T;
    isDefaultNamespace(namespace: string): boolean;
    isEqualNode(otherNode: Node): boolean;
    isSameNode(otherNode: Node): boolean;
    lookupNamespaceURI(prefix: string): string;
    lookupPrefix(namespace: string): string;
    normalize(): void;
    removeChild<T extends Node>(child: T): T;
    removeEventListener(
        type: string,
        callback: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    replaceChild<T extends Node>(node: Node, child: T): T;
}

Hierarchy (View Summary)

EventTarget
- Node

Properties

`Readonly`ATTRIBUTE_NODE

ATTRIBUTE_NODE: 2

`Readonly`baseURI

baseURI: string

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

`Readonly`CDATA_SECTION_NODE

CDATA_SECTION_NODE: 4

node is a CDATASection node.

`Readonly`childNodes

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.

`Readonly`COMMENT_NODE

COMMENT_NODE: 8

node is a Comment node.

`Readonly`DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

`Readonly`DOCUMENT_NODE

DOCUMENT_NODE: 9

node is a document.

`Readonly`DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

`Readonly`DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

`Readonly`DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: 1

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

`Readonly`DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

`Readonly`DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

`Readonly`DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

`Readonly`DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: 10

node is a doctype.

`Readonly`ELEMENT_NODE

ELEMENT_NODE: 1

node is an element.

`Readonly`ENTITY_NODE

ENTITY_NODE: 6

`Readonly`ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: 5

`Readonly`firstChild

firstChild: ChildNode

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.

`Readonly`isConnected

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.

`Readonly`lastChild

lastChild: ChildNode

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

`Readonly`nextSibling

nextSibling: ChildNode

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.

`Readonly`nodeName

nodeName: string

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

`Readonly`nodeType

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.

nodeValue

nodeValue: string

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

`Readonly`NOTATION_NODE

NOTATION_NODE: 12

`Readonly`ownerDocument

ownerDocument: Document

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

`Readonly`parentElement

parentElement: HTMLElement

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.

`Readonly`parentNode

parentNode: ParentNode

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

`Readonly`previousSibling

previousSibling: ChildNode

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.

`Readonly`PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

`Readonly`TEXT_NODE

TEXT_NODE: 3

node is a Text node.

textContent

textContent: string

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

Methods

addEventListener

addEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): 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
- type: string
- callback: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:14380

appendChild

appendChild<T extends Node>(node: T): 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
- T extends Node
Parameters
- node: T
Returns T
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26125

cloneNode

cloneNode(subtree?: boolean): 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
- Optionalsubtree: boolean
Returns Node
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26131

compareDocumentPosition

compareDocumentPosition(other: Node): 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
- other: Node
Returns number
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26137

contains

contains(other: Node): 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
- other: Node
Returns boolean
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26143

dispatchEvent

dispatchEvent(event: 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
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:14386

getRootNode

getRootNode(options?: GetRootNodeOptions): 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
- Optionaloptions: GetRootNodeOptions
Returns Node
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26149

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
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26155

insertBefore

insertBefore<T extends Node>(node: T, child: Node): 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
- T extends Node
Parameters
- node: T
- child: Node
Returns T
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26161

isDefaultNamespace

isDefaultNamespace(namespace: string): 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
- namespace: string
Returns boolean
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26167

isEqualNode

isEqualNode(otherNode: Node): 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
- otherNode: Node
Returns boolean
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26173

isSameNode

isSameNode(otherNode: Node): 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
- otherNode: Node
Returns boolean
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26179

lookupNamespaceURI

lookupNamespaceURI(prefix: string): string
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
- prefix: string
Returns string
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26185

lookupPrefix

lookupPrefix(namespace: string): string
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
- namespace: string
Returns string
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26191

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
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26197

removeChild

removeChild<T extends Node>(child: T): T
The removeChild() method of the Node interface removes a child node from the DOM and returns the removed node.

MDN Reference
Type Parameters
- T extends Node
Parameters
- child: T
Returns T
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26203

removeEventListener

removeEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): 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
- type: string
- callback: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:14392

replaceChild

replaceChild<T extends Node>(node: Node, child: T): T
The replaceChild() method of the Node interface replaces a child node within the given (parent) node.

MDN Reference
Type Parameters
- T extends Node
Parameters
- node: Node
- child: T
Returns T
- Defined in node_modules/typescript/lib/lib.dom.d.ts:26209