Children of this node. Do not modify this directly, use NodeLogic or instance methods.
Next sibling node, or null if none exists. Do not modify this directly, use NodeLogic or instance methods.
Extra DOM data associated with this node. This object prototypically inherits from the parent node's nodeData.
Set of unique string tags applied to this node. These tags do not inherit and are unique to each instance. Meaning is tag-specific.
Type of this node
Parent of this node, or null if there is none. Do not modify this directly, use NodeLogic or instance methods.
Previous sibling node, or null if none exists. Do not modify this directly, use NodeLogic or instance methods.
The first child node of this parent, or null if there are no children.
The first child node that is a TagNode, or null if there is none.
The first child node that is a TextNode, or null if there is none.
The last child node of this parent, or null if there are no children.
The last child node that is a TagNode, or null if there is none.
The last child node that is a TextNode, or null if there is none.
The closest following sibling that is a TagNode, or null if none exists.
The closest following sibling that is a TextNode, or null if none exists.
The closest previous sibling that is a TagNode, or null if none exists.
The closest previous sibling that is a TextNode, or null if none exists.
Inserts a child at the end of this parent's children
Node to insert
Append multiple children to the end of this parent's child list
Child nodes to append. Can be empty.
Inserts a sibling node after this one
Node to insert
Removes all children from this node
Removes all children from this node and creates a new DocumentNode containing them.
the created DocumentNode
Finds the first child node that matches a condition. Returns null if no match found.
Callback to test condition
If true, children of child nodes will also be searched.
First matching child, or null
Finds the first child node of a specified type. Returns null if none found.
Type of node to match
If true, children of child nodes will also be searched.
The first node that matches, or null
Finds all child nodes that match a condition. Returns an empty array if no matches found.
Callback to test condition
If true, children of child nodes will also be searched.
Array of all Nodes that match condition
Finds all child nodes of a specified type.
Type of node to match
If true, children of child nodes will also be searched.
Array of all matching child nodes
Finds the first child TagNode that matches a condition. Returns null if no match found.
Callback to test condition
If true, children of child nodes will also be searched.
First TagNode that matches the condition, or null.
Finds the first child TagNode with the specified tag name. Result may be a subclass of TagNode if a custom tag type is specified. Returns null if none found.
Tag name to match
If true, children of child nodes will also be searched.
First matching TagNode, or null.
Finds all child TagNodes that match a condition. Returns an empty array if no matches found.
Callback to test condition
If true, children of child nodes will also be searched.
Array of all TagNodes that match condition
Finds all child TagNodes with the specified tag name. Results may be a subclass of TagNode if a custom tag type is specified. Returns null if none found.
Tag name to match
If true, children of child nodes will also be searched.
Array of all matching TagNodes
Finds the next node that matches a callback. The next node is defined as the first matching child, sibling, or sibling's child node starting from this node. This only checks child and sibling nodes, it will not move further up the DOM tree. To check only sibling nodes, set node to false.
Callback to test nodes
If true or not specified, then child nodes will be checked
The first matching node, or null if none found.
Gets all child TagNodes from this parent
array of TagNodes containing all child tags
Inserts a child at the start of this parent's children
Node to insert
Prepend multiple children to the start of this parent's child list
Child nodes to prepend. Can be empty.
Inserts a sibling node before this one
Node to insert
Removes this node from the DOM, but optionally preserves children. If keepChildren is true, then child nodes will be reattached to the DOM in place of this node. Effectively "promotes" child nodes.
If true, child nodes will be kept.
Remove this node and all children from the DOM, and insert one or more nodes in its place
Nodes to insert in replacement. Can be empty.
Set the root scope of this DOM. The root scope is inherited by all nodes, but is read-only.
Scope object to inherit from
Serializes this node into HTML. Child nodes will be automatically serialize.
HTML text representation of this node
Returns true if a node is an instance of DocumentNode
Node to check
Returns true if a node is an instance of NodeWithChildren
Node to check
Generated using TypeDoc
A document node. Is a "root" node, so it cannot have a parent. DOM trees are not required to have a DocumentNode root, but it exists as a utility to make DOM processing easier.