DocumentType
The DocumentType interface represents a Node containing a doctype.
Extends
Accessors
textContent
Get Signature
get textContent(): null;
Returns
null
The textContent property of the Node interface represents the text content of the node and its descendants.
Overrides
Methods
addEventListener()
addEventListener(
type,
callback,
options?
): void;
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Parameters
| Parameter | Type |
|---|---|
type | string |
callback | | EventListenerOrEventListenerObject | null |
options? | boolean | AddEventListenerOptions |
Returns
void
Inherited from
after()
after(...nodes): 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.
Parameters
| Parameter | Type |
|---|---|
...nodes | (string | Node)[] |
Returns
void
Inherited from
appendChild()
appendChild<T>(node): T;
The appendChild() method of the Node interface adds a node to the end of the list of children of a specified parent node.
Type Parameters
| Type Parameter |
|---|
T extends Node |
Parameters
| Parameter | Type |
|---|---|
node | T |
Returns
T
Inherited from
before()
before(...nodes): 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.
Parameters
| Parameter | Type |
|---|---|
...nodes | (string | Node)[] |
Returns
void
Inherited from
cloneNode()
cloneNode(subtree?): Node;
The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in the node is also cloned or not.
Parameters
| Parameter | Type |
|---|---|
subtree? | boolean |
Returns
Inherited from
compareDocumentPosition()
compareDocumentPosition(other): number;
The compareDocumentPosition() method of the Node interface reports the position of its argument node relative to the node on which it is called.
Parameters
| Parameter | Type |
|---|---|
other | Node |
Returns
number
Inherited from
contains()
contains(other): boolean;
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 (childNodes), one of the children's direct children, and so on.
Parameters
| Parameter | Type |
|---|---|
other | Node | null |
Returns
boolean
Inherited from
dispatchEvent()
dispatchEvent(event): boolean;
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
Parameters
| Parameter | Type |
|---|---|
event | Event |
Returns
boolean
Inherited from
getRootNode()
getRootNode(options?): Node;
The getRootNode() method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.
Parameters
| Parameter | Type |
|---|---|
options? | GetRootNodeOptions |
Returns
Inherited from
hasChildNodes()
hasChildNodes(): boolean;
The hasChildNodes() method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.
Returns
boolean
Inherited from
insertBefore()
insertBefore<T>(node, child): T;
The insertBefore() method of the Node interface inserts a node before a reference node as a child of a specified parent node.
Type Parameters
| Type Parameter |
|---|
T extends Node |
Parameters
| Parameter | Type |
|---|---|
node | T |
child | Node | null |
Returns
T
Inherited from
isDefaultNamespace()
isDefaultNamespace(namespace): boolean;
The isDefaultNamespace() method of the Node interface accepts a namespace URI as an argument. It returns a boolean value that is true if the namespace is the default namespace on the given node and false if not. The default namespace can be retrieved with Node.lookupNamespaceURI() by passing null as the argument.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
Returns
boolean
Inherited from
isEqualNode()
isEqualNode(otherNode): boolean;
The isEqualNode() method of the Node interface tests whether two nodes are equal. Two nodes are equal when they have the same type, defining characteristics (for elements, this would be their ID, number of children, and so forth), its attributes match, and so on. The specific set of data points that must match varies depending on the types of the nodes.
Parameters
| Parameter | Type |
|---|---|
otherNode | Node | null |
Returns
boolean
Inherited from
isSameNode()
isSameNode(otherNode): boolean;
The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
Parameters
| Parameter | Type |
|---|---|
otherNode | Node | null |
Returns
boolean
Inherited from
lookupNamespaceURI()
lookupNamespaceURI(prefix): string | null;
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). This method's existence allows Node objects to be passed as a namespace resolver to XPathEvaluator.createExpression() and XPathEvaluator.evaluate().
Parameters
| Parameter | Type |
|---|---|
prefix | string | null |
Returns
string | null
Inherited from
lookupPrefix()
lookupPrefix(namespace): 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. When multiple prefixes are possible, the first prefix is returned.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
Returns
string | null
Inherited from
normalize()
normalize(): void;
The normalize() method of the Node interface puts the specified node and all of its sub-tree into a normalized form. In a normalized sub-tree, no text nodes in the sub-tree are empty and there are no adjacent text nodes.
Returns
void
Inherited from
remove()
remove(): void;
Removes node.
Returns
void
Inherited from
removeChild()
removeChild<T>(child): T;
The removeChild() method of the Node interface removes a child node from the DOM and returns the removed node.
Type Parameters
| Type Parameter |
|---|
T extends Node |
Parameters
| Parameter | Type |
|---|---|
child | T |
Returns
T
Inherited from
removeEventListener()
removeEventListener(
type,
callback,
options?
): void;
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
Parameters
| Parameter | Type |
|---|---|
type | string |
callback | | EventListenerOrEventListenerObject | null |
options? | boolean | EventListenerOptions |
Returns
void
Inherited from
replaceChild()
replaceChild<T>(node, child): T;
The replaceChild() method of the Node interface replaces a child node within the given (parent) node.
Type Parameters
| Type Parameter |
|---|
T extends Node |
Parameters
| Parameter | Type |
|---|---|
node | Node |
child | T |
Returns
T
Inherited from
replaceWith()
replaceWith(...nodes): 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.
Parameters
| Parameter | Type |
|---|---|
...nodes | (string | Node)[] |
Returns
void
Inherited from
Properties
ATTRIBUTE_NODE
readonly ATTRIBUTE_NODE: 2;
Inherited from
baseURI
readonly baseURI: string;
The read-only baseURI property of the Node interface returns the absolute base URL of the document containing the node.
Inherited from
CDATA_SECTION_NODE
readonly CDATA_SECTION_NODE: 4;
node is a CDATASection node.
Inherited from
childNodes
readonly childNodes: NodeListOf<ChildNode>;
The read-only childNodes property of the Node interface returns a live NodeList of child nodes of the given element where the first child node is assigned index 0. Child nodes include elements, text and comments.
Inherited from
COMMENT_NODE
readonly COMMENT_NODE: 8;
node is a Comment node.
Inherited from
DOCUMENT_FRAGMENT_NODE
readonly DOCUMENT_FRAGMENT_NODE: 11;
node is a DocumentFragment node.
Inherited from
DOCUMENT_NODE
readonly DOCUMENT_NODE: 9;
node is a document.
Inherited from
DOCUMENT_POSITION_CONTAINED_BY
readonly DOCUMENT_POSITION_CONTAINED_BY: 16;
Set when other is a descendant of node.
Inherited from
Node.DOCUMENT_POSITION_CONTAINED_BY
DOCUMENT_POSITION_CONTAINS
readonly DOCUMENT_POSITION_CONTAINS: 8;
Set when other is an ancestor of node.
Inherited from
Node.DOCUMENT_POSITION_CONTAINS
DOCUMENT_POSITION_DISCONNECTED
readonly DOCUMENT_POSITION_DISCONNECTED: 1;
Set when node and other are not in the same tree.
Inherited from
Node.DOCUMENT_POSITION_DISCONNECTED
DOCUMENT_POSITION_FOLLOWING
readonly DOCUMENT_POSITION_FOLLOWING: 4;
Set when other is following node.
Inherited from
Node.DOCUMENT_POSITION_FOLLOWING
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
Inherited from
Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
DOCUMENT_POSITION_PRECEDING
readonly DOCUMENT_POSITION_PRECEDING: 2;
Set when other is preceding node.
Inherited from
Node.DOCUMENT_POSITION_PRECEDING
DOCUMENT_TYPE_NODE
readonly DOCUMENT_TYPE_NODE: 10;
node is a doctype.
Inherited from
ELEMENT_NODE
readonly ELEMENT_NODE: 1;
node is an element.
Inherited from
ENTITY_NODE
readonly ENTITY_NODE: 6;
Inherited from
ENTITY_REFERENCE_NODE
readonly ENTITY_REFERENCE_NODE: 5;
Inherited from
firstChild
readonly 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.
Inherited from
isConnected
readonly 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.
Inherited from
lastChild
readonly 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.
Inherited from
name
readonly name: string;
The read-only name property of the DocumentType returns the type of the document.
nextSibling
readonly nextSibling: ChildNode | null;
The read-only nextSibling property of the Node interface returns the node immediately following the specified one in their parent's childNodes, or returns null if the specified node is the last child in the parent element.
Inherited from
nodeName
readonly nodeName: string;
The read-only nodeName property of Node returns the name of the current node as a string.
Inherited from
nodeType
readonly nodeType: number;
The read-only nodeType property of a Node interface is an integer that identifies what the node is. It distinguishes different kinds of nodes from each other, such as elements, text, and comments.
Inherited from
nodeValue
nodeValue: string | null;
The nodeValue property of the Node interface returns or sets the value of the current node.
Inherited from
NOTATION_NODE
readonly NOTATION_NODE: 12;
Inherited from
ownerDocument
readonly ownerDocument: Document;
The read-only ownerDocument property of the Node interface returns the top-level document object of the node.
Overrides
parentElement
readonly 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. Node.parentNode on the other hand returns any kind of parent, regardless of its type.
Inherited from
parentNode
readonly parentNode: ParentNode | null;
The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree.
Inherited from
previousSibling
readonly previousSibling: ChildNode | null;
The read-only previousSibling property of the Node interface returns the node immediately preceding the specified one in its parent's childNodes list, or null if the specified node is the first in that list.
Inherited from
PROCESSING_INSTRUCTION_NODE
readonly PROCESSING_INSTRUCTION_NODE: 7;
node is a ProcessingInstruction node.
Inherited from
Node.PROCESSING_INSTRUCTION_NODE
publicId
readonly publicId: string;
The read-only publicId property of the DocumentType returns a formal identifier of the document.
systemId
readonly systemId: string;
The read-only systemId property of the DocumentType returns the URL of the associated DTD.
TEXT_NODE
readonly TEXT_NODE: 3;
node is a Text node.