AwaitedDOM/ 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. Comments are represented in HTML and XML as content between '<!--' and '-->'. In XML, the character sequence '--' cannot be used within a comment.

Properties

node.data
W3C

Is a string representing the textual data contained in this object.

Type: Promise<string>

node.length
W3C

Returns an unsigned long representing the size of the string contained in CharacterData.data.

Type: Promise<number>

node.baseURI
W3C

Returns a string representing the base URL of the document containing the Node.

Type: Promise<string>

node.childNodes
W3C

Returns a live NodeList containing all the children of this node. NodeList being live means that if the children of the Node change, the NodeList object is automatically updated.

Type: SuperNodeList

node.firstChild
W3C

Returns a Node representing the first direct child node of the node, or null if the node has no child.

Type: SuperNode

node.isConnected
W3C

A boolean indicating whether or not the Node is connected (directly or indirectly) to the context object, e.g. the Document object in the case of the normal DOM, or the ShadowRoot in the case of a shadow DOM.

Type: Promise<boolean>

node.lastChild
W3C

Returns a Node representing the last direct child node of the node, or null if the node has no child.

Type: SuperNode

node.nextSibling
W3C

Returns a Node representing the next node in the tree, or null if there isn't such node.

Type: SuperNode

node.nodeName
W3C

Returns a string containing the name of the Node. The structure of the name will differ with the node type. E.g. An HTMLElement will contain the name of the corresponding tag, like 'audio' for an HTMLAudioElement, a Text node will have the '#text' string, or a Document node will have the '#document' string.

Type: Promise<string>

node.nodeType
W3C

Returns an unsigned short representing the type of the node. Possible values are:

NameValue
ELEMENT_NODE1
ATTRIBUTE_NODE 2
TEXT_NODE3
CDATA_SECTION_NODE4
ENTITY_REFERENCE_NODE 5
ENTITY_NODE 6
PROCESSING_INSTRUCTION_NODE7
COMMENT_NODE8
DOCUMENT_NODE9
DOCUMENT_TYPE_NODE10
DOCUMENT_FRAGMENT_NODE11
NOTATION_NODE 12

Type: Promise<number>

node.nodeValue
W3C

Returns / Sets the value of the current node.

Type: Promise<string>

node.ownerDocument
W3C

Returns the Document that this node belongs to. If the node is itself a document, returns null.

Type: SuperDocument

node.parentElement
W3C

Returns an Element that is the parent of this node. If the node has no parent, or if that parent is not an Element, this property returns null.

Type: SuperElement

node.parentNode
W3C

Returns a Node that is the parent of this node. If there is no such node, like if this node is the top of the tree or if doesn't participate in a tree, this property returns null.

Type: SuperNode

node.previousSibling
W3C

Returns a Node representing the previous node in the tree, or null if there isn't such node.

Type: SuperNode

node.textContent
W3C

Returns / Sets the textual content of an element and all its descendants.

Type: Promise<string>

node.nextElementSibling
W3C

Returns the Element immediately following this node in its parent's children list, or null if there is no Element in the list following this node.

Type: SuperElement

node.previousElementSibling
W3C

Returns the Element immediately prior to this node in its parent's children list, or null if there is no Element in the list prior to this node.

Type: SuperElement

Methods

node.substringData(offset, count)
W3C

Returns a string containing the part of CharacterData.data of the specified length and starting at the specified offset.

Arguments:

  • offset number. Needs content.
  • count number. Needs content.

Returns: Promise<string>

node.compareDocumentPosition(other)
W3C

Compares the position of the current node against another node in any other document.

Arguments:

  • other Node. The other Node with which to compare the first node’s document position.

Returns: Promise<number>

node.contains(other)
W3C

Returns a boolean value indicating whether or not a node is a descendant of the calling node.

Arguments:

  • other Node. Needs content.

Returns: Promise<boolean>

node.getRootNode(options?)
W3C

Returns the context object's root which optionally includes the shadow root if it is available. 

Arguments:

  • options GetRootNodeOptions. An object that sets options for getting the root node. The available options are:
    • composed: A `boolean` that indicates whether the shadow root should be returned (false, the default), or a root node beyond shadow root (true).

Returns: SuperNode

node.hasChildNodes()
W3C

Returns a boolean indicating whether or not the element has any child nodes.

Returns: Promise<boolean>

node.isDefaultNamespace(namespace)
W3C

Accepts a namespace URI as an argument and returns a boolean with a value of true if the namespace is the default namespace on the given node or false if not.

Arguments:

  • namespace string. namespaceURI is a string representing the namespace against which the element will be checked.

Returns: Promise<boolean>

node.isEqualNode(otherNode)
W3C

Returns a boolean which indicates whether or not two nodes are of the same type and all their defining data points match.

Arguments:

  • otherNode Node. otherNode: The Node to compare equality with.

Returns: Promise<boolean>

node.isSameNode(otherNode)
W3C

Returns a boolean value indicating whether or not the two nodes are the same (that is, they reference the same object).

Arguments:

  • otherNode Node. otherNode The Node to test against.

Returns: Promise<boolean>

node.lookupNamespaceURI(prefix)
W3C

Accepts a prefix and returns the namespace URI associated with it on the given node if found (and null if not). Supplying null for the prefix will return the default namespace.

Arguments:

  • prefix string. The prefix to look for. If this parameter is null, the method will return the default namespace URI, if any.

Returns: Promise<string>

node.lookupPrefix(namespace)
W3C

Returns a string containing the prefix for a given namespace URI, if present, and null if not. When multiple prefixes are possible, the result is implementation-dependent.

Arguments:

  • namespace string. Needs content.

Returns: Promise<string>

node.normalize()
W3C

Clean up all the text nodes under this element (merge adjacent, remove empty).

Returns: Promise<void>

Unimplemented Specs

Methods

appendData()deleteData()
insertData()replaceData()
appendChild()cloneNode()
insertBefore()removeChild()
replaceChild()addEventListener()
dispatchEvent()removeEventListener()
after()before()
remove()replaceWith()

Edit this page on GitHub