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 SpecificationThe definition of 'XPathResult.invalidIteratorState' in that specification. | Recommendation | Initial definition |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
invalidIteratorState
|
Chrome
Full support Yes |
Edge
Full support 12 |
Firefox
Full support Yes |
IE
No support No |
Opera
Full support Yes |
Safari
? |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support Yes |
Opera Android
Full support Yes |
Safari iOS
? |
Samsung Internet Android
Full support Yes |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
XPathResult.invalidIteratorState by Mozilla Contributors is licensed under CC-BY-SA 2.5.