W3cubDocs

/Web APIs

XPathResult: snapshotLength property

The read-only snapshotLength property of the XPathResult interface represents the number of nodes in the result snapshot.

Note: This feature is available in Web Workers

Value

An integer value representing the number of nodes in the result snapshot.

Exceptions

TYPE_ERR

In case XPathResult.resultType is not UNORDERED_NODE_SNAPSHOT_TYPE or ORDERED_NODE_SNAPSHOT_TYPE, an XPathException of type TYPE_ERR is thrown.

Examples

The following example shows the use of the snapshotLength property.

HTML

html

<div>XPath example</div>
<div>Number of matched nodes: <output></output></div>

JavaScript

js

const xpath = "//div";
const result = document.evaluate(
  xpath,
  document,
  null,
  XPathResult.ORDERED_NODE_SNAPSHOT_TYPE,
  null,
);
document.querySelector("output").textContent = result.snapshotLength;

Result

Specifications

Specification
DOM Standard
# dom-xpathresult-snapshotlength

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
snapshotLength 1 12 1 No ≤12.1 3 4.4 18 4 ≤12.1 1 1.0

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/XPathResult/snapshotLength