Skip to main content

XPathResult

The XPathResult interface represents the results generated by evaluating an XPath expression within the context of a given node.

MDN Reference

Methods​

iterateNext()​

iterateNext(): Node | null;

The iterateNext() method of the XPathResult interface iterates over a node set result and returns the next node from it or null if there are no more nodes.

MDN Reference

Returns​

Node | null

snapshotItem()​

snapshotItem(index): Node | null;

The snapshotItem() method of the XPathResult interface returns an item of the snapshot collection or null in case the index is not within the range of nodes. Unlike the iterator result, the snapshot does not become invalid, but may not correspond to the current document if it is mutated.

MDN Reference

Parameters​

ParameterType
indexnumber

Returns​

Node | null

Properties​

ANY_TYPE​

readonly ANY_TYPE: 0;

ANY_UNORDERED_NODE_TYPE​

readonly ANY_UNORDERED_NODE_TYPE: 8;

BOOLEAN_TYPE​

readonly BOOLEAN_TYPE: 3;

booleanValue​

readonly booleanValue: boolean;

The read-only booleanValue property of the XPathResult interface returns the boolean value of a result with XPathResult.resultType being BOOLEAN_TYPE.

MDN Reference

FIRST_ORDERED_NODE_TYPE​

readonly FIRST_ORDERED_NODE_TYPE: 9;

invalidIteratorState​

readonly invalidIteratorState: boolean;

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.

MDN Reference

NUMBER_TYPE​

readonly NUMBER_TYPE: 1;

numberValue​

readonly numberValue: number;

The read-only numberValue property of the XPathResult interface returns the numeric value of a result with XPathResult.resultType being NUMBER_TYPE.

MDN Reference

ORDERED_NODE_ITERATOR_TYPE​

readonly ORDERED_NODE_ITERATOR_TYPE: 5;

ORDERED_NODE_SNAPSHOT_TYPE​

readonly ORDERED_NODE_SNAPSHOT_TYPE: 7;

resultType​

readonly resultType: number;

The read-only resultType property of the XPathResult interface represents the type of the result, as defined by the type constants.

MDN Reference

singleNodeValue​

readonly singleNodeValue: Node | null;

The read-only singleNodeValue property of the XPathResult interface returns a Node value or null in case no node was matched of a result with XPathResult.resultType being ANY_UNORDERED_NODE_TYPE or FIRST_ORDERED_NODE_TYPE.

MDN Reference

snapshotLength​

readonly snapshotLength: number;

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

MDN Reference

STRING_TYPE​

readonly STRING_TYPE: 2;

stringValue​

readonly stringValue: string;

The read-only stringValue property of the XPathResult interface returns the string value of a result with XPathResult.resultType being STRING_TYPE.

MDN Reference

UNORDERED_NODE_ITERATOR_TYPE​

readonly UNORDERED_NODE_ITERATOR_TYPE: 4;

UNORDERED_NODE_SNAPSHOT_TYPE​

readonly UNORDERED_NODE_SNAPSHOT_TYPE: 6;