GitHub Repository: ulixee/secret-agent
Path: blob/main/website/awaited-dom/CDATASection.md
¹⁰²⁸ views

AwaitedDOM / CDATASection

The CDATASection interface represents a CDATA section that can be used within XML to include extended portions of unescaped text. The symbols < and & don’t need escaping as they normally do when inside a CDATA section.

In XML, a CDATA section looks like:

Properties

.wholeText
W3C {#wholeText}

Returns a string containing the text of all Text nodes logically adjacent to this Node, concatenated in document order.

Type: `Promise<string>`

.data
W3C {#data}

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

Type: `Promise<string>`

.length
W3C {#length}

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

Type: `Promise<number>`

.baseURI
W3C {#baseURI}

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

Type: `Promise<string>`

.childNodes
W3C {#childNodes}

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`

.firstChild
W3C {#firstChild}

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

Type: `SuperNode`

.isConnected
W3C {#isConnected}

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

.lastChild
W3C {#lastChild}

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

Type: `SuperNode`

.nextSibling
W3C {#nextSibling}

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

Type: `SuperNode`

.nodeName
W3C {#nodeName}

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

.nodeType
W3C {#nodeType}

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


    Name Value
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

Name	Value
`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`

Type: `Promise<number>`

.nodeValue
W3C {#nodeValue}

Returns / Sets the value of the current node.

Type: `Promise<string>`

.ownerDocument
W3C {#ownerDocument}

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

Type: `SuperDocument`

.parentElement
W3C {#parentElement}

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`

.parentNode
W3C {#parentNode}

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`

.previousSibling
W3C {#previousSibling}

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

Type: `SuperNode`

.textContent
W3C {#textContent}

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

Type: `Promise<string>`

.assignedSlot
W3C {#assignedSlot}

Returns the <slot> the node is inserted in.

Type: `HTMLSlotElement`

.nextElementSibling
W3C {#nextElementSibling}

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`

.previousElementSibling
W3C {#previousElementSibling}

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

.splitText(offset)
W3C {#splitText}

Breaks the node into two nodes at a specified offset.

Arguments:

offset number. The index immediately before which to break the text node.

Returns: `Promise<SuperText>`

.substringData(offset, count)
W3C {#substringData}

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

.compareDocumentPosition(other)
W3C {#compareDocumentPosition}

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

.contains(other)
W3C {#contains}

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

.getRootNode(options?)
W3C {#getRootNode}

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`

.hasChildNodes()
W3C {#hasChildNodes}

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

Returns: `Promise<boolean>`

.isDefaultNamespace(namespace)
W3C {#isDefaultNamespace}

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

.isEqualNode(otherNode)
W3C {#isEqualNode}

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

.isSameNode(otherNode)
W3C {#isSameNode}

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

.lookupNamespaceURI(prefix)
W3C {#lookupNamespaceURI}

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

.lookupPrefix(namespace)
W3C {#lookupPrefix}

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

.normalize()
W3C {#normalize}

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()`

AwaitedDOM / CDATASection

Properties

.wholeText W3C {#wholeText}

Type: Promise<string>

.data W3C {#data}

Type: Promise<string>

.length W3C {#length}

Type: Promise<number>

.baseURI W3C {#baseURI}

Type: Promise<string>

.childNodes W3C {#childNodes}

Type: SuperNodeList

.firstChild W3C {#firstChild}

Type: SuperNode

.isConnected W3C {#isConnected}

Type: Promise<boolean>

.lastChild W3C {#lastChild}

Type: SuperNode

.nextSibling W3C {#nextSibling}

Type: SuperNode

.nodeName W3C {#nodeName}

Type: Promise<string>

.nodeType W3C {#nodeType}

Type: Promise<number>

.nodeValue W3C {#nodeValue}

Type: Promise<string>

.ownerDocument W3C {#ownerDocument}

Type: SuperDocument

.parentElement W3C {#parentElement}

Type: SuperElement

.parentNode W3C {#parentNode}

Type: SuperNode

.previousSibling W3C {#previousSibling}

Type: SuperNode

.textContent W3C {#textContent}

Type: Promise<string>

.assignedSlot W3C {#assignedSlot}

Type: HTMLSlotElement

.nextElementSibling W3C {#nextElementSibling}

Type: SuperElement

.previousElementSibling W3C {#previousElementSibling}

Type: SuperElement

Methods

.splitText*(offset)* W3C {#splitText}

Arguments:

Returns: Promise<SuperText>

.substringData*(offset, count)* W3C {#substringData}

Arguments:

Returns: Promise<string>

.compareDocumentPosition*(other)* W3C {#compareDocumentPosition}

Arguments:

Returns: Promise<number>

.contains*(other)* W3C {#contains}

Arguments:

Returns: Promise<boolean>

.getRootNode*(options?)* W3C {#getRootNode}

Arguments:

Returns: SuperNode

.hasChildNodes*()* W3C {#hasChildNodes}

Returns: Promise<boolean>

.isDefaultNamespace*(namespace)* W3C {#isDefaultNamespace}

Arguments:

Returns: Promise<boolean>

.isEqualNode*(otherNode)* W3C {#isEqualNode}

Arguments:

Returns: Promise<boolean>

.isSameNode*(otherNode)* W3C {#isSameNode}

Arguments:

Returns: Promise<boolean>

.lookupNamespaceURI*(prefix)* W3C {#lookupNamespaceURI}

Arguments:

Returns: Promise<string>

.lookupPrefix*(namespace)* W3C {#lookupPrefix}

Arguments:

Returns: Promise<string>

.normalize*()* W3C {#normalize}

Returns: Promise<void>

Unimplemented Specs

Methods

.wholeText
W3C {#wholeText}

Type: `Promise<string>`

.data
W3C {#data}

Type: `Promise<string>`

.length
W3C {#length}

Type: `Promise<number>`

.baseURI
W3C {#baseURI}

Type: `Promise<string>`

.childNodes
W3C {#childNodes}

Type: `SuperNodeList`

.firstChild
W3C {#firstChild}

Type: `SuperNode`

.isConnected
W3C {#isConnected}

Type: `Promise<boolean>`

.lastChild
W3C {#lastChild}

Type: `SuperNode`

.nextSibling
W3C {#nextSibling}

Type: `SuperNode`

.nodeName
W3C {#nodeName}

Type: `Promise<string>`

.nodeType
W3C {#nodeType}

Type: `Promise<number>`

.nodeValue
W3C {#nodeValue}

Type: `Promise<string>`

.ownerDocument
W3C {#ownerDocument}

Type: `SuperDocument`

.parentElement
W3C {#parentElement}

Type: `SuperElement`

.parentNode
W3C {#parentNode}

Type: `SuperNode`

.previousSibling
W3C {#previousSibling}

Type: `SuperNode`

.textContent
W3C {#textContent}

Type: `Promise<string>`

.assignedSlot
W3C {#assignedSlot}

Type: `HTMLSlotElement`

.nextElementSibling
W3C {#nextElementSibling}

Type: `SuperElement`

.previousElementSibling
W3C {#previousElementSibling}

Type: `SuperElement`

.splitText(offset)
W3C {#splitText}

Returns: `Promise<SuperText>`

.substringData(offset, count)
W3C {#substringData}

Returns: `Promise<string>`

.compareDocumentPosition(other)
W3C {#compareDocumentPosition}

Returns: `Promise<number>`

.contains(other)
W3C {#contains}

Returns: `Promise<boolean>`

.getRootNode(options?)
W3C {#getRootNode}

Returns: `SuperNode`

.hasChildNodes()
W3C {#hasChildNodes}

Returns: `Promise<boolean>`

.isDefaultNamespace(namespace)
W3C {#isDefaultNamespace}

Returns: `Promise<boolean>`

.isEqualNode(otherNode)
W3C {#isEqualNode}

Returns: `Promise<boolean>`

.isSameNode(otherNode)
W3C {#isSameNode}

Returns: `Promise<boolean>`

.lookupNamespaceURI(prefix)
W3C {#lookupNamespaceURI}

Returns: `Promise<string>`

.lookupPrefix(namespace)
W3C {#lookupPrefix}

Returns: `Promise<string>`

.normalize()
W3C {#normalize}

Returns: `Promise<void>`