Interface Comment

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;
    CDATA_SECTION_NODE: 4;
    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;
    NOTATION_NODE: 12;
    PROCESSING_INSTRUCTION_NODE: 7;
    TEXT_NODE: 3;
    baseURI: string;
    childNodes: NodeListOf<ChildNode>;
    data: string;
    firstChild: null | ChildNode;
    isConnected: boolean;
    lastChild: null | ChildNode;
    length: number;
    nextElementSibling: null | Element;
    nextSibling: null | ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: null | string;
    ownerDocument: Document;
    parentElement: null | HTMLElement;
    parentNode: null | ParentNode;
    previousElementSibling: null | Element;
    previousSibling: null | ChildNode;
    textContent: null | string;
    addEventListener(type: string, callback: null | EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
    after(...nodes: (string | Node)[]): void;
    appendChild<T>(node: T): T;
    appendData(data: string): void;
    before(...nodes: (string | Node)[]): void;
    cloneNode(deep?: boolean): Node;
    compareDocumentPosition(other: Node): number;
    contains(other: null | Node): boolean;
    deleteData(offset: number, count: number): void;
    dispatchEvent(event: Event): boolean;
    getRootNode(options?: GetRootNodeOptions): Node;
    hasChildNodes(): boolean;
    insertBefore<T>(node: T, child: null | Node): T;
    insertData(offset: number, data: string): void;
    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;
    remove(): void;
    removeChild<T>(child: T): T;
    removeEventListener(type: string, callback: null | EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
    replaceChild<T>(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 (view full)

Properties

ATTRIBUTE_NODE: 2
CDATA_SECTION_NODE: 4

node is a CDATASection node.

COMMENT_NODE: 8

node is a Comment node.

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
NOTATION_NODE: 12
PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

TEXT_NODE: 3

node is a Text node.

baseURI: string

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

MDN Reference

childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

data: string
firstChild: null | ChildNode

Returns the first child.

MDN Reference

isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

lastChild: null | ChildNode

Returns the last child.

MDN Reference

length: number
nextElementSibling: null | Element

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

MDN Reference

nextSibling: null | ChildNode

Returns the next sibling.

MDN Reference

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

nodeType: number

Returns the type of node.

MDN Reference

nodeValue: null | string
ownerDocument: Document

Returns the node document. Returns null for documents.

MDN Reference

parentElement: null | HTMLElement

Returns the parent element.

MDN Reference

parentNode: null | ParentNode

Returns the parent.

MDN Reference

previousElementSibling: null | Element

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

MDN Reference

previousSibling: null | ChildNode

Returns the previous sibling.

MDN Reference

textContent: null | string

Methods

  • 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

    Returns void

  • 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

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

    Returns void

  • Type Parameters

    Parameters

    • node: T

    Returns T

  • 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

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

    Returns void

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

    MDN Reference

    Parameters

    • Optionaldeep: boolean

    Returns Node

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

    MDN Reference

    Parameters

    Returns number

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

    MDN Reference

    Parameters

    Returns boolean

  • Parameters

    • offset: number
    • count: number

    Returns void

  • 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

  • Returns whether node has children.

    MDN Reference

    Returns boolean

  • Type Parameters

    Parameters

    • node: T
    • child: null | Node

    Returns T

  • Parameters

    • offset: number
    • data: string

    Returns void

  • Parameters

    • namespace: null | string

    Returns boolean

  • Returns whether node and otherNode have the same properties.

    MDN Reference

    Parameters

    • otherNode: null | Node

    Returns boolean

  • Parameters

    • otherNode: null | Node

    Returns boolean

  • Parameters

    • prefix: null | string

    Returns null | string

  • Parameters

    • namespace: null | string

    Returns null | string

  • 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

  • Removes node.

    MDN Reference

    Returns void

  • Type Parameters

    Parameters

    • child: T

    Returns T

  • 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

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

    Returns void

  • Parameters

    • offset: number
    • count: number

    Returns string