Skip to main content

NodeIterator

The NodeIterator interface represents an iterator to traverse nodes of a DOM subtree in document order.

MDN Reference

Methods​

detach()​

detach(): void;

The NodeIterator.detach() method is a no-op, kept for backward compatibility only.

Returns​

void

Deprecated​

MDN Reference

nextNode()​

nextNode(): Node | null;

The NodeIterator.nextNode() method returns the next node in the set represented by the NodeIterator and advances the position of the iterator within the set. The first call to nextNode() returns the first node in the set.

MDN Reference

Returns​

Node | null

previousNode()​

previousNode(): Node | null;

The NodeIterator.previousNode() method returns the previous node in the set represented by the NodeIterator and moves the position of the iterator backwards within the set.

MDN Reference

Returns​

Node | null

Properties​

filter​

readonly filter: NodeFilter | null;

The NodeIterator.filter read-only property returns a NodeFilter object, that is an object which implements an acceptNode(node) method, used to screen nodes.

MDN Reference

pointerBeforeReferenceNode​

readonly pointerBeforeReferenceNode: boolean;

The NodeIterator.pointerBeforeReferenceNode read-only property returns a boolean flag that indicates whether the NodeFilter is anchored before (if this value is true) or after (if this value is false) the anchor node indicated by the NodeIterator.referenceNode property.

MDN Reference

referenceNode​

readonly referenceNode: Node;

The NodeIterator.referenceNode read-only property returns the Node to which the iterator is anchored; as new nodes are inserted, the iterator remains anchored to the reference node as specified by this property.

MDN Reference

root​

readonly root: Node;

The NodeIterator.root read-only property represents the Node that is the root of what the NodeIterator traverses.

MDN Reference

whatToShow​

readonly whatToShow: number;

The NodeIterator.whatToShow read-only property represents an unsigned integer representing a bitmask signifying what types of nodes should be returned by the NodeIterator.

MDN Reference