XPathResult.invalidIteratorState

The read-only invalidIteratorState property of the XPathResult interface signifies that the iterator has become invalid. It is true if XPathResult.resultType is UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE and the document has been modified since this result was returned.

Note:

This feature is available in Web Workers.

Syntax

var iteratorState = result.invalidIteratorState;

Return value

A boolean value indicating whether the iterator has become invalid.

Example

The following example shows the use of the invalidIteratorState property.

HTML

<div>XPath example</div>
<p>Iterator state: <output></output></p>

JavaScript

var xpath = "//div";
var result = document.evaluate(xpath, document, null, XPathResult.ANY_TYPE, null);
// Invalidates the iterator state
document.querySelector("div").remove();
document.querySelector("output").textContent = result.invalidIteratorState ? "invalid" : "valid";

Result

Specifications

Specification Status Comment
Document Object Model (DOM) Level 3 XPath Specification
The definition of 'XPathResult.invalidIteratorState' in that specification.
Recommendation Initial definition

Browser compatibility

BCD tables only load in the browser