XPathResult: iterateNext() method
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
The iterateNext() method of the
XPathResult interface iterates over a node set result and returns the
next node from it or null if there are no more nodes.
Syntax
js
iterateNext()
Parameters
None.
Return value
The next Node within the node set of the XPathResult.
Exceptions
TYPE_ERR
In case XPathResult.resultType is not
UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE, a
DOMException of type TYPE_ERR is thrown.
INVALID_STATE_ERR
If the document is mutated since the result was returned, a
DOMException of type INVALID_STATE_ERR is thrown.
Examples
The following example shows the use of the iterateNext() method.
HTML
html
<div>XPath example</div>
<div>Tag names of the matched nodes: <output></output></div>
JavaScript
js
const xpath = "//div";
const result = document.evaluate(
xpath,
document,
null,
XPathResult.ANY_TYPE,
null,
);
let node = null;
const tagNames = [];
while ((node = result.iterateNext())) {
tagNames.push(node.localName);
}
document.querySelector("output").textContent = tagNames.join(", ");
Result
Specifications
| Specification |
|---|
| DOM # dom-xpathresult-iteratenext |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
iterateNext
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support