XPathResult: invalidIteratorState property

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.

Note: This feature is available in Web Workers.

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.

Value

A boolean value indicating whether the iterator has become invalid.

Examples

The following example shows the use of the invalidIteratorState property.

HTML

html

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

JavaScript

const xpath = "//div";
const 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
DOM Standard # dom-xpathresult-invaliditeratorstate

Browser compatibility

BCD tables only load in the browser