ParentNode

Node is an interface from which a number of DOM API object types inherit. It allows those types to be treated similarly; for example, inheriting the same set of methods, or being tested in the same way.

MDN Reference

interface ParentNode {
    charging?: boolean;
    chargingTime?: number;
    dischargingTime?: number;
    level?: number;
    addEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    dispatchEvent(event: Event): boolean;
    removeEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    baseURI: string;
    childNodes: NodeListOf<ChildNode>;
    firstChild: null | ChildNode;
    isConnected: boolean;
    lastChild: null | ChildNode;
    nextSibling: null | ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: null | string;
    ownerDocument: null | Document;
    parentElement: null | HTMLElement;
    parentNode: null | ParentNode;
    previousSibling: null | ChildNode;
    textContent: null | string;
    appendChild<T extends Node>(node: T): T;
    cloneNode(subtree?: boolean): Node;
    compareDocumentPosition(other: Node): number;
    contains(other: null | Node): 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;
    removeChild<T extends Node>(child: T): T;
    replaceChild<T extends Node>(node: Node, child: T): T;
    ELEMENT_NODE: 1;
    ATTRIBUTE_NODE: 2;
    TEXT_NODE: 3;
    CDATA_SECTION_NODE: 4;
    ENTITY_REFERENCE_NODE: 5;
    ENTITY_NODE: 6;
    PROCESSING_INSTRUCTION_NODE: 7;
    COMMENT_NODE: 8;
    DOCUMENT_NODE: 9;
    DOCUMENT_TYPE_NODE: 10;
    DOCUMENT_FRAGMENT_NODE: 11;
    NOTATION_NODE: 12;
    DOCUMENT_POSITION_DISCONNECTED: 1;
    DOCUMENT_POSITION_PRECEDING: 2;
    DOCUMENT_POSITION_FOLLOWING: 4;
    DOCUMENT_POSITION_CONTAINS: 8;
    DOCUMENT_POSITION_CONTAINED_BY: 16;
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
    childElementCount: number;
    children: HTMLCollection;
    firstElementChild: null | Element;
    lastElementChild: null | Element;
    append(...nodes: (string | Node)[]): 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>;
    replaceChildren(...nodes: (string | Node)[]): void;
}

Hierarchy (View Summary)

Node
- ParentNode

Index

Properties

Properties

`Optional`charging

charging?: boolean

`Optional`chargingTime

chargingTime?: number

`Optional`dischargingTime

dischargingTime?: number

`Optional`level

level?: number

`Readonly`baseURI

baseURI: string

Returns node's node document's document base URL.

MDN Reference

`Readonly`childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

`Readonly`firstChild

firstChild: null | ChildNode

Returns the first child.

MDN Reference

`Readonly`isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

`Readonly`lastChild

lastChild: null | ChildNode

Returns the last child.

MDN Reference

`Readonly`nextSibling

nextSibling: null | ChildNode

Returns the next sibling.

MDN Reference

`Readonly`nodeName

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

`Readonly`nodeType

nodeType: number

Returns the type of node.

MDN Reference

nodeValue

nodeValue: null | string

MDN Reference

`Readonly`ownerDocument

ownerDocument: null | Document

Returns the node document. Returns null for documents.

MDN Reference

`Readonly`parentElement

parentElement: null | HTMLElement

Returns the parent element.

MDN Reference

`Readonly`parentNode

parentNode: null | ParentNode

Returns the parent.

MDN Reference

`Readonly`previousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

MDN Reference

textContent

textContent: null | string

MDN Reference

`Readonly`ELEMENT_NODE

ELEMENT_NODE: 1

node is an element.

`Readonly`ATTRIBUTE_NODE

ATTRIBUTE_NODE: 2

`Readonly`TEXT_NODE

TEXT_NODE: 3

node is a Text node.

`Readonly`CDATA_SECTION_NODE

CDATA_SECTION_NODE: 4

node is a CDATASection node.

`Readonly`ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: 5

`Readonly`ENTITY_NODE

ENTITY_NODE: 6

`Readonly`PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

`Readonly`COMMENT_NODE

COMMENT_NODE: 8

node is a Comment node.

`Readonly`DOCUMENT_NODE

DOCUMENT_NODE: 9

node is a document.

`Readonly`DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: 10

node is a doctype.

`Readonly`DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

`Readonly`NOTATION_NODE

NOTATION_NODE: 12

`Readonly`DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: 1

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

`Readonly`DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

`Readonly`DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

`Readonly`DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

`Readonly`DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

`Readonly`DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

`Readonly`childElementCount

childElementCount: number

MDN Reference

`Readonly`children

children: HTMLCollection

Returns the child elements.

MDN Reference

`Readonly`firstElementChild

firstElementChild: null | Element

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

MDN Reference

`Readonly`lastElementChild

lastElementChild: null | Element

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

MDN Reference

Methods

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference

Parameters

```
type: string
```

callback: null | EventListenerOrEventListenerObject

Optionaloptions: boolean | AddEventListenerOptions

Returns void

dispatchEvent

dispatchEvent(event: Event): boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

Parameters

```
event: Event
```

Returns boolean

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void

Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference

Parameters

```
type: string
```

callback: null | EventListenerOrEventListenerObject

Optionaloptions: boolean | EventListenerOptions

Returns void

appendChild

appendChild<T extends Node>(node: T): T

MDN Reference

Type Parameters

T extends Node

Parameters

```
node: T
```

Returns T

cloneNode

cloneNode(subtree?: boolean): Node

Returns a copy of node. If deep is true, the copy also includes the node's descendants.

MDN Reference

Parameters

```
Optionalsubtree: boolean
```

Returns Node

compareDocumentPosition

compareDocumentPosition(other: Node): number

Returns a bitmask indicating the position of other relative to node.

MDN Reference

Parameters

```
other: Node
```

Returns number

contains

contains(other: null | Node): boolean

Returns true if other is an inclusive descendant of node, and false otherwise.

MDN Reference

Parameters

```
other: null | Node
```

Returns boolean

getRootNode

getRootNode(options?: GetRootNodeOptions): Node

Returns node's root.

MDN Reference

Parameters

```
Optionaloptions: GetRootNodeOptions
```

Returns Node

hasChildNodes

hasChildNodes(): boolean

Returns whether node has children.

MDN Reference

Returns boolean

insertBefore

insertBefore<T extends Node>(node: T, child: null | Node): T

MDN Reference

Type Parameters

T extends Node

Parameters

```
node: T
```
```
child: null | Node
```

Returns T

isDefaultNamespace

isDefaultNamespace(namespace: null | string): boolean

MDN Reference

Parameters

```
namespace: null | string
```

Returns boolean

isEqualNode

isEqualNode(otherNode: null | Node): boolean

Returns whether node and otherNode have the same properties.

MDN Reference

Parameters

```
otherNode: null | Node
```

Returns boolean

isSameNode

isSameNode(otherNode: null | Node): boolean

MDN Reference

Parameters

```
otherNode: null | Node
```

Returns boolean

lookupNamespaceURI

lookupNamespaceURI(prefix: null | string): null | string

MDN Reference

Parameters

```
prefix: null | string
```

Returns null | string

lookupPrefix

lookupPrefix(namespace: null | string): null | string

MDN Reference

Parameters

```
namespace: null | string
```

Returns null | string

normalize

normalize(): void

Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

MDN Reference

Returns void

removeChild

removeChild<T extends Node>(child: T): T

MDN Reference

Type Parameters

T extends Node

Parameters

```
child: T
```

Returns T

replaceChild

replaceChild<T extends Node>(node: Node, child: T): T

MDN Reference

Type Parameters

T extends Node

Parameters

```
node: Node
```
```
child: T
```

Returns T

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

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>

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)[]
```

ParentNode

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Optionalcharging

OptionalchargingTime

OptionaldischargingTime

Optionallevel

ReadonlybaseURI

ReadonlychildNodes

ReadonlyfirstChild

ReadonlyisConnected

ReadonlylastChild

ReadonlynextSibling

ReadonlynodeName

ReadonlynodeType

nodeValue

ReadonlyownerDocument

ReadonlyparentElement

ReadonlyparentNode

ReadonlypreviousSibling

textContent

ReadonlyELEMENT_NODE

ReadonlyATTRIBUTE_NODE

ReadonlyTEXT_NODE

ReadonlyCDATA_SECTION_NODE

ReadonlyENTITY_REFERENCE_NODE

ReadonlyENTITY_NODE

ReadonlyPROCESSING_INSTRUCTION_NODE

ReadonlyCOMMENT_NODE

ReadonlyDOCUMENT_NODE

ReadonlyDOCUMENT_TYPE_NODE

ReadonlyDOCUMENT_FRAGMENT_NODE

ReadonlyNOTATION_NODE

ReadonlyDOCUMENT_POSITION_DISCONNECTED

ReadonlyDOCUMENT_POSITION_PRECEDING

ReadonlyDOCUMENT_POSITION_FOLLOWING

ReadonlyDOCUMENT_POSITION_CONTAINS

ReadonlyDOCUMENT_POSITION_CONTAINED_BY

ReadonlyDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

ReadonlychildElementCount

Readonlychildren

ReadonlyfirstElementChild

ReadonlylastElementChild

Methods

addEventListener

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

removeEventListener

Parameters

Returns void

appendChild

Type Parameters

Parameters

Returns T

cloneNode

Parameters

Returns Node

compareDocumentPosition

Parameters

Returns number

contains

Parameters

Returns boolean

getRootNode

Parameters

Returns Node

hasChildNodes

Returns boolean

insertBefore

Type Parameters

Parameters

Returns T

isDefaultNamespace

Parameters

`Optional`charging

`Optional`chargingTime

`Optional`dischargingTime

`Optional`level

`Readonly`baseURI

`Readonly`childNodes

`Readonly`firstChild

`Readonly`isConnected

`Readonly`lastChild

`Readonly`nextSibling

`Readonly`nodeName

`Readonly`nodeType

`Readonly`ownerDocument

`Readonly`parentElement

`Readonly`parentNode

`Readonly`previousSibling

`Readonly`ELEMENT_NODE

`Readonly`ATTRIBUTE_NODE

`Readonly`TEXT_NODE

`Readonly`CDATA_SECTION_NODE

`Readonly`ENTITY_REFERENCE_NODE

`Readonly`ENTITY_NODE

`Readonly`PROCESSING_INSTRUCTION_NODE

`Readonly`COMMENT_NODE

`Readonly`DOCUMENT_NODE

`Readonly`DOCUMENT_TYPE_NODE

`Readonly`DOCUMENT_FRAGMENT_NODE

`Readonly`NOTATION_NODE

`Readonly`DOCUMENT_POSITION_DISCONNECTED

`Readonly`DOCUMENT_POSITION_PRECEDING

`Readonly`DOCUMENT_POSITION_FOLLOWING

`Readonly`DOCUMENT_POSITION_CONTAINS

`Readonly`DOCUMENT_POSITION_CONTAINED_BY

`Readonly`DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

`Readonly`childElementCount

`Readonly`children

`Readonly`firstElementChild

`Readonly`lastElementChild