XPathResult.snapshotLength

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.

Syntax

var snapshotLength = result.snapshotLength;

Return 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.

Example

The following example shows the use of the snapshotLength property.

HTML

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

JavaScript

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

Result

Specifications

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

Browser compatibility

No compatibility data found. Please contribute data for "api.XPathResult.snapshotLength" (depth: 1) to the MDN compatibility data repository.

Document Tags and Contributors

Contributors to this page: mdnwebdocs-bot, Sebastianz
Last updated by: mdnwebdocs-bot,