Interface ParentNode

The DOM Node interface is an abstract base class upon which many other DOM API objects are based, thus letting those object types to be used similarly and often interchangeably.

MDN Reference

interface ParentNode {
    ATTRIBUTE_NODE: 2;
    baseURI: string;
    CDATA_SECTION_NODE: 4;
    childElementCount: number;
    childNodes: NodeListOf<ChildNode>;
    children: HTMLCollection;
    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: null | ChildNode;
    firstElementChild: null | Element;
    isConnected: boolean;
    lastChild: null | ChildNode;
    lastElementChild: null | Element;
    nextSibling: null | ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: null | string;
    NOTATION_NODE: 12;
    ownerDocument: null | Document;
    parentElement: null | HTMLElement;
    parentNode: null | ParentNode;
    previousSibling: null | ChildNode;
    PROCESSING_INSTRUCTION_NODE: 7;
    TEXT_NODE: 3;
    textContent: null | string;
    addEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    append(...nodes: (string | Node)[]): void;
    appendChild<T extends Node>(node: T): T;
    cloneNode(subtree?: boolean): Node;
    compareDocumentPosition(other: Node): number;
    contains(other: null | Node): boolean;
    dispatchEvent(event: Event): boolean;
    getRootNode(options?: GetRootNodeOptions): Node;
    hasChildNodes(): boolean;
    insertBefore<T extends Node>(node: T, child: null | Node): T;
    isDefaultNamespace(namespace: null | string): boolean;
    isEqualNode(otherNode: null | Node): boolean;
    isSameNode(otherNode: null | Node): boolean;
    lookupNamespaceURI(prefix: null | string): null | string;
    lookupPrefix(namespace: null | string): null | string;
    normalize(): void;
    prepend(...nodes: (string | Node)[]): void;
    querySelector<K extends keyof HTMLElementTagNameMap>(
        selectors: K,
    ): null | HTMLElementTagNameMap[K];
    querySelector<K extends keyof SVGElementTagNameMap>(
        selectors: K,
    ): null | SVGElementTagNameMap[K];
    querySelector<K extends keyof MathMLElementTagNameMap>(
        selectors: K,
    ): null | MathMLElementTagNameMap[K];
    querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): null | HTMLElementDeprecatedTagNameMap[K];
    querySelector<E extends Element = Element>(selectors: string): null | E;
    querySelectorAll<K extends keyof HTMLElementTagNameMap>(
        selectors: K,
    ): NodeListOf<HTMLElementTagNameMap[K]>;
    querySelectorAll<K extends keyof SVGElementTagNameMap>(
        selectors: K,
    ): NodeListOf<SVGElementTagNameMap[K]>;
    querySelectorAll<K extends keyof MathMLElementTagNameMap>(
        selectors: K,
    ): NodeListOf<MathMLElementTagNameMap[K]>;
    querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;
    querySelectorAll<E extends Element = Element>(
        selectors: string,
    ): NodeListOf<E>;
    removeChild<T extends Node>(child: T): T;
    removeEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    replaceChild<T extends Node>(node: Node, child: T): T;
    replaceChildren(...nodes: (string | Node)[]): void;
}

Hierarchy (View Summary)

Node
- ParentNode

Index

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.

MDN Reference

`Readonly`CDATA_SECTION_NODE

CDATA_SECTION_NODE: 4

node is a CDATASection node.

`Readonly`childElementCount

childElementCount: number

MDN Reference

`Readonly`childNodes

childNodes: NodeListOf<ChildNode>

The read-only childNodes property of the Node interface returns a live the first child node is assigned index 0.

MDN Reference

`Readonly`children

children: HTMLCollection

Returns the child elements.

MDN Reference

`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: null | 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.

MDN Reference

`Readonly`firstElementChild

firstElementChild: null | Element

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

MDN Reference

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

MDN Reference

`Readonly`lastChild

lastChild: null | 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.

MDN Reference

`Readonly`lastElementChild

lastElementChild: null | Element

Returns the last child that is an element, and null otherwise.

MDN Reference

`Readonly`nextSibling

nextSibling: null | ChildNode

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

MDN Reference

`Readonly`nodeName

nodeName: string

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

MDN Reference

`Readonly`nodeType

nodeType: number

The read-only nodeType property of a Node interface is an integer that identifies what the node is.

MDN Reference

nodeValue

nodeValue: null | string

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

MDN Reference

`Readonly`NOTATION_NODE

NOTATION_NODE: 12

`Readonly`ownerDocument

ownerDocument: null | Document

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

MDN Reference

`Readonly`parentElement

parentElement: null | 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.

MDN Reference

`Readonly`parentNode

parentNode: null | ParentNode

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

MDN Reference

`Readonly`previousSibling

previousSibling: null | ChildNode

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

MDN Reference

`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: null | string

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

MDN Reference

Methods

addEventListener

addEventListener(
    type: string,
    callback: null | 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: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from Node.addEventListener

append

append(...nodes: (string | Node)[]): void
Inserts nodes after the last child of 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
- ...nodes: (string | Node)[]
Returns void

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
Inherited from Node.appendChild

cloneNode

cloneNode(subtree?: boolean): Node
The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called.

MDN Reference
Parameters
- Optionalsubtree: boolean
Returns Node
Inherited from Node.cloneNode

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
Inherited from Node.compareDocumentPosition

contains

contains(other: null | 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 (Node.childNodes), one of the children's direct children, and so on.

MDN Reference
Parameters
- other: null | Node
Returns boolean
Inherited from Node.contains

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.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from Node.dispatchEvent

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
Inherited from Node.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 Node.hasChildNodes

insertBefore

insertBefore<T extends Node>(node: T, child: null | 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: null | Node
Returns T
Inherited from Node.insertBefore

isDefaultNamespace

isDefaultNamespace(namespace: null | string): boolean
The isDefaultNamespace() method of the Node interface accepts a namespace URI as an argument.

MDN Reference
Parameters
- namespace: null | string
Returns boolean
Inherited from Node.isDefaultNamespace

isEqualNode

isEqualNode(otherNode: null | Node): boolean
The isEqualNode() method of the Node interface tests whether two nodes are equal.

MDN Reference
Parameters
- otherNode: null | Node
Returns boolean
Inherited from Node.isEqualNode

isSameNode

isSameNode(otherNode: null | Node): boolean
The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator.

MDN Reference
Parameters
- otherNode: null | Node
Returns boolean
Inherited from Node.isSameNode

lookupNamespaceURI

lookupNamespaceURI(prefix: null | string): null | 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).

MDN Reference
Parameters
- prefix: null | string
Returns null | string
Inherited from Node.lookupNamespaceURI

lookupPrefix

lookupPrefix(namespace: null | string): null | 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.

MDN Reference
Parameters
- namespace: null | string
Returns null | string
Inherited from Node.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.

MDN Reference

Returns void
Inherited from Node.normalize

prepend

prepend(...nodes: (string | Node)[]): void
Inserts nodes before the first child of 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
- ...nodes: (string | Node)[]
Returns void

querySelector

querySelector<K extends keyof HTMLElementTagNameMap>(
selectors: K,
): null | HTMLElementTagNameMap[K]
Returns the first element that is a descendant of node that matches selectors.

MDN Reference
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns null | HTMLElementTagNameMap[K]
querySelector<K extends keyof SVGElementTagNameMap>(
selectors: K,
): null | SVGElementTagNameMap[K]
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns null | SVGElementTagNameMap[K]
querySelector<K extends keyof MathMLElementTagNameMap>(
selectors: K,
): null | MathMLElementTagNameMap[K]
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- selectors: K
Returns null | MathMLElementTagNameMap[K]
querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(
selectors: K,
): null | HTMLElementDeprecatedTagNameMap[K]
Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- selectors: K
Returns null | HTMLElementDeprecatedTagNameMap[K]
Deprecated
querySelector<E extends Element = Element>(selectors: string): null | E
Type Parameters
- E extends Element = Element
Parameters
- selectors: string
Returns null | E

querySelectorAll

querySelectorAll<K extends keyof HTMLElementTagNameMap>(
selectors: K,
): NodeListOf<HTMLElementTagNameMap[K]>
Returns all element descendants of node that match selectors.

MDN Reference
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<HTMLElementTagNameMap[K]>
querySelectorAll<K extends keyof SVGElementTagNameMap>(
selectors: K,
): NodeListOf<SVGElementTagNameMap[K]>
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<SVGElementTagNameMap[K]>
querySelectorAll<K extends keyof MathMLElementTagNameMap>(
selectors: K,
): NodeListOf<MathMLElementTagNameMap[K]>
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<MathMLElementTagNameMap[K]>
querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(
selectors: K,
): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- selectors: K
Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Deprecated
querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>
Type Parameters
- E extends Element = Element
Parameters
- selectors: string
Returns NodeListOf<E>

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
Inherited from Node.removeChild

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from Node.removeEventListener

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
Inherited from Node.replaceChild

replaceChildren

replaceChildren(...nodes: (string | Node)[]): void
Replace all children of 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
- ...nodes: (string | Node)[]
Returns void

Interface ParentNode

Hierarchy (View Summary)

Index

Properties

Methods

Properties

ReadonlyATTRIBUTE_NODE

ReadonlybaseURI

ReadonlyCDATA_SECTION_NODE

ReadonlychildElementCount

ReadonlychildNodes

Readonlychildren

ReadonlyCOMMENT_NODE

ReadonlyDOCUMENT_FRAGMENT_NODE

ReadonlyDOCUMENT_NODE

ReadonlyDOCUMENT_POSITION_CONTAINED_BY

ReadonlyDOCUMENT_POSITION_CONTAINS

ReadonlyDOCUMENT_POSITION_DISCONNECTED

ReadonlyDOCUMENT_POSITION_FOLLOWING

ReadonlyDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

ReadonlyDOCUMENT_POSITION_PRECEDING

ReadonlyDOCUMENT_TYPE_NODE

ReadonlyELEMENT_NODE

ReadonlyENTITY_NODE

ReadonlyENTITY_REFERENCE_NODE

ReadonlyfirstChild

ReadonlyfirstElementChild

ReadonlyisConnected

ReadonlylastChild

ReadonlylastElementChild

ReadonlynextSibling

ReadonlynodeName

ReadonlynodeType

nodeValue

ReadonlyNOTATION_NODE

ReadonlyownerDocument

ReadonlyparentElement

ReadonlyparentNode

ReadonlypreviousSibling

ReadonlyPROCESSING_INSTRUCTION_NODE

ReadonlyTEXT_NODE

textContent

Methods

addEventListener

Parameters

Returns void

append

Parameters

Returns void

appendChild

Type Parameters

Parameters

Returns T

cloneNode

Parameters

Returns Node

compareDocumentPosition

Parameters

Returns number

contains

Parameters

Returns boolean

dispatchEvent

Parameters

Returns boolean

getRootNode

Parameters

Returns Node

hasChildNodes

Returns boolean

insertBefore

Type Parameters

Parameters

Returns T

isDefaultNamespace

Parameters

Returns boolean

isEqualNode

Parameters

Returns boolean

`Readonly`ATTRIBUTE_NODE

`Readonly`baseURI

`Readonly`CDATA_SECTION_NODE

`Readonly`childElementCount

`Readonly`childNodes

`Readonly`children

`Readonly`COMMENT_NODE

`Readonly`DOCUMENT_FRAGMENT_NODE

`Readonly`DOCUMENT_NODE

`Readonly`DOCUMENT_POSITION_CONTAINED_BY

`Readonly`DOCUMENT_POSITION_CONTAINS

`Readonly`DOCUMENT_POSITION_DISCONNECTED

`Readonly`DOCUMENT_POSITION_FOLLOWING

`Readonly`DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

`Readonly`DOCUMENT_POSITION_PRECEDING

`Readonly`DOCUMENT_TYPE_NODE

`Readonly`ELEMENT_NODE

`Readonly`ENTITY_NODE

`Readonly`ENTITY_REFERENCE_NODE

`Readonly`firstChild

`Readonly`firstElementChild

`Readonly`isConnected

`Readonly`lastChild

`Readonly`lastElementChild

`Readonly`nextSibling

`Readonly`nodeName

`Readonly`nodeType

`Readonly`NOTATION_NODE

`Readonly`ownerDocument

`Readonly`parentElement

`Readonly`parentNode

`Readonly`previousSibling

`Readonly`PROCESSING_INSTRUCTION_NODE

`Readonly`TEXT_NODE