XPathResult: snapshotLength 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 snapshotLength property of the XPathResult interface represents the number of nodes in the result snapshot.

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

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

BCD tables only load in the browser