fontoxpath/src/evaluateXPathToFirstNode.js

A minimalistic XPath 3.1 engine in JavaScript

import evaluateXPath from './evaluateXPath';

/**
 * Evaluates an XPath on the given contextNode. Returns the first node result.
 *
 * @param  {!string}           selector     The selector to execute. Supports XPath 3.1.
 * @param  {!Node}             contextNode    The node from which to run the XPath.
 * @param  {?IDomFacade=}      domFacade      The domFacade (or DomFacade like interface) for retrieving relations.
 * @param  {?Object=}          variables      Extra variables (name=>value). Values can be number / string or boolean.
 * @param  {?Object=}           options      Extra options for evaluating this XPath
 *
 * @return  {!Node}            The first matching node, in the order defined by the XPath
 */
export default function evaluateXPathToFirstNode (selector, contextNode, domFacade, variables, options) {
	return /** @type {!Node} */ (evaluateXPath(selector, contextNode, domFacade, variables, evaluateXPath.FIRST_NODE_TYPE, options));
}