Interface Comment

The Comment interface represents textual notations within markup; although it is generally not visually shown, such comments are available to be read in the source view.

MDN Reference

interface Comment {
    ATTRIBUTE_NODE: 2;
    baseURI: string;
    CDATA_SECTION_NODE: 4;
    childNodes: NodeListOf<ChildNode>;
    COMMENT_NODE: 8;
    data: string;
    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 | null;
    isConnected: boolean;
    lastChild: ChildNode | null;
    length: number;
    nextElementSibling: Element | null;
    nextSibling: ChildNode | null;
    nodeName: string;
    nodeType: number;
    nodeValue: string | null;
    NOTATION_NODE: 12;
    ownerDocument: Document;
    parentElement: HTMLElement | null;
    parentNode: ParentNode | null;
    previousElementSibling: Element | null;
    previousSibling: ChildNode | null;
    PROCESSING_INSTRUCTION_NODE: 7;
    TEXT_NODE: 3;
    get textContent(): string;
    set textContent(value: string | null): void;
    addEventListener(
        type: string,
        callback: EventListenerOrEventListenerObject | null,
        options?: boolean | AddEventListenerOptions,
    ): void;
    after(...nodes: (string | Node)[]): void;
    appendChild<T extends Node>(node: T): T;
    appendData(data: string): void;
    before(...nodes: (string | Node)[]): void;
    cloneNode(subtree?: boolean): Node;
    compareDocumentPosition(other: Node): number;
    contains(other: Node | null): boolean;
    deleteData(offset: number, count: number): void;
    dispatchEvent(event: Event): boolean;
    getRootNode(options?: GetRootNodeOptions): Node;
    hasChildNodes(): boolean;
    insertBefore<T extends Node>(node: T, child: Node | null): T;
    insertData(offset: number, data: string): void;
    isDefaultNamespace(namespace: string | null): boolean;
    isEqualNode(otherNode: Node | null): boolean;
    isSameNode(otherNode: Node | null): boolean;
    lookupNamespaceURI(prefix: string | null): string | null;
    lookupPrefix(namespace: string | null): string | null;
    normalize(): void;
    remove(): void;
    removeChild<T extends Node>(child: T): T;
    removeEventListener(
        type: string,
        callback: EventListenerOrEventListenerObject | null,
        options?: boolean | EventListenerOptions,
    ): void;
    replaceChild<T extends Node>(node: Node, child: T): T;
    replaceData(offset: number, count: number, data: string): void;
    replaceWith(...nodes: (string | Node)[]): void;
    substringData(offset: number, count: number): string;
}
Hierarchy
Index

Properties

ATTRIBUTE_NODE baseURI CDATA_SECTION_NODE childNodes COMMENT_NODE data DOCUMENT_FRAGMENT_NODE DOCUMENT_NODE DOCUMENT_POSITION_CONTAINED_BY DOCUMENT_POSITION_CONTAINS DOCUMENT_POSITION_DISCONNECTED DOCUMENT_POSITION_FOLLOWING DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC DOCUMENT_POSITION_PRECEDING DOCUMENT_TYPE_NODE ELEMENT_NODE ENTITY_NODE ENTITY_REFERENCE_NODE firstChild isConnected lastChild length nextElementSibling nextSibling nodeName nodeType nodeValue NOTATION_NODE ownerDocument parentElement parentNode previousElementSibling previousSibling PROCESSING_INSTRUCTION_NODE TEXT_NODE

Accessors

textContent

Methods

addEventListener after appendChild appendData before cloneNode compareDocumentPosition contains deleteData dispatchEvent getRootNode hasChildNodes insertBefore insertData isDefaultNamespace isEqualNode isSameNode lookupNamespaceURI lookupPrefix normalize remove removeChild removeEventListener replaceChild replaceData replaceWith substringData

Properties

ATTRIBUTE_NODE: 2
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: 4

node is a CDATASection node.

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

COMMENT_NODE: 8

node is a Comment node.

data: string

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

MDN Reference

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

DOCUMENT_NODE: 9

node is a document.

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

DOCUMENT_POSITION_DISCONNECTED: 1

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

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32
DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

DOCUMENT_TYPE_NODE: 10

node is a doctype.

ELEMENT_NODE: 1

node is an element.

ENTITY_NODE: 6
ENTITY_REFERENCE_NODE: 5
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: 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: 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

length: number

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

MDN Reference

nextElementSibling: Element | null

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

MDN Reference

nextSibling: ChildNode | null

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

nodeName: string

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

MDN Reference

nodeType: number

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

MDN Reference

nodeValue: string | null

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

MDN Reference

NOTATION_NODE: 12
ownerDocument: Document

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

MDN Reference

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.

MDN Reference

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

previousElementSibling: Element | null

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

MDN Reference

previousSibling: ChildNode | null

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

PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

ReadonlyTEXT_NODE

TEXT_NODE: 3

node is a Text node.

Accessors

  • get textContent(): string

    MDN Reference

    Returns string

  • set textContent(value: string | null): void

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

    MDN Reference

    Parameters

    • value: string | null

    Returns void

Methods

  • 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

    • ...nodes: (string | Node)[]

    Returns void

  • 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

    Parameters

    • node: T

    Returns T

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

    MDN Reference

    Parameters

    • data: string

    Returns 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

    • ...nodes: (string | Node)[]

    Returns void

  • 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

  • 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

    Returns number

  • 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

    Returns boolean

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

    MDN Reference

    Parameters

    • offset: number
    • count: number

    Returns void

  • 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

  • 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

  • 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

    Parameters

    • node: T
    • child: Node | null

    Returns T

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

    MDN Reference

    Parameters

    • offset: number
    • data: string

    Returns void

  • The isDefaultNamespace() method of the Node interface accepts a namespace URI as an argument.

    MDN Reference

    Parameters

    • namespace: string | null

    Returns boolean

  • The isEqualNode() method of the Node interface tests whether two nodes are equal.

    MDN Reference

    Parameters

    • otherNode: Node | null

    Returns boolean

  • The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator.

    MDN Reference

    Parameters

    • otherNode: Node | null

    Returns boolean

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

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

    MDN Reference

    Parameters

    • namespace: string | null

    Returns string | null

  • 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

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

    MDN Reference

    Type Parameters

    Parameters

    • child: T

    Returns T

  • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

    MDN Reference

    Parameters

    Returns void

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

    MDN Reference

    Type Parameters

    Parameters

    Returns T

  • 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

    • offset: number
    • count: number
    • data: string

    Returns 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

    • ...nodes: (string | Node)[]

    Returns void

  • 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

    • offset: number
    • count: number

    Returns string

Settings

Member Visibility

On This Page

Properties
Accessors
Methods