TreeWalker

TreeWalker

Generalization and simplification of the TreeWalker web API for the normal and worker contexts.

Constructor

new TreeWalker(root, acceptNodeopt, onlyElementNodesopt, startNodeopt)

Source:

src/TreeWalker.js, line 6

Create a tree walker.

Parameters:

Name	Type	Attributes	Default	Description
`root`	Node \| external:Node			Node that limits where the tree walker can go within this document's tree: only the root node and its descendants.
`acceptNode`	function	<optional>		Function that returns `true` if the tree walker should accept the node and `false` if it should reject.
`onlyElementNodes`	boolean	<optional>	`false`	Walk only on element nodes, ignoring nodes of other types.
`startNode`	Node \| external:Node	<optional>	`root`	Node to set as a current node.

Methods

firstChild() → (nullable) {Node}

Source:

src/TreeWalker.js, line 71

Go to the first child node.

Returns:

Type: Node

lastChild() → (nullable) {Node}

Source:

src/TreeWalker.js, line 80

Go to the last child node.

Returns:

Type: Node

nextNode() → (nullable) {Node}

Source:

src/TreeWalker.js, line 107

Go to the next node (don't confuse with the next sibling).

Returns:

Type: Node

nextSibling() → (nullable) {Node}

Source:

src/TreeWalker.js, line 98

Go to the next sibling node.

Returns:

Type: Node

parentNode() → (nullable) {Node}

Source:

src/TreeWalker.js, line 62

Go to the parent node.

Returns:

Type: Node

previousNode() → (nullable) {Node}

Source:

src/TreeWalker.js, line 130

Go to the previous node (don't confuse with the previous sibling).

Returns:

Type: Node

previousSibling() → (nullable) {Node}

Source:

src/TreeWalker.js, line 89

Go to the previous sibling node.

Returns:

Type: Node

(protected) tryMove(prop) → (nullable) {Node}

Source:

src/TreeWalker.js, line 43

Try changing the current node to a node specified by the property.

Parameters:

Name	Type	Description
`prop`	string

Returns:

Type: Node