EagleoutIce
XPath library for TypeScript 4/5
DOM 3 and 4 XPath 1.0 implementation for browser and Node.js environment (which works with TypeScript5) with support for custom Function, Variable and Namespace mapping.
Requirements
Release Notes
See CHANGELOG.md
Usage
Install with npm:
npm install xpath-tsThis library is xml engine agnostic, but I recommend to use xmldom-ts, xmldom or jsdom
npm install xmldom-tsor
npm install xmldomor
npm install jsdomAPI Documentation
Can be found here. See below for example usage.
Your first xpath:
import { DOMParserImpl as dom } from 'xmldom-ts';
import * as xpath from 'xpath-ts';
const xml = '<book><title>Harry Potter</title></book>';
const doc = new dom().parseFromString(xml);
const nodes = xpath.select('//title', doc);
console.log(nodes[0].localName + ': ' + nodes[0].firstChild.data);
console.log('Node: ' + nodes[0].toString());➡
title: Harry Potter
Node: <title>Harry Potter</title>Alternatively
Using the same interface you have on modern browsers (MDN)
import { DOMParserImpl as dom } from 'xmldom-ts';
import * as xpath from 'xpath-ts';
const xml = "<book author='J. K. Rowling'><title>Harry Potter</title></book>";
const doc = new dom().parseFromString(xml);
xpath.installDOM3XPathSupport(doc);
const result = doc.evaluate(
'/book/title', // xpathExpression
doc, // contextNode
null, // namespaceResolver
xpath.XPathResult.ANY_TYPE, // resultType
null // result
);
let node = result.iterateNext();
while (node) {
console.log(node.localName + ': ' + node.firstChild.data);
console.log('Node: ' + node.toString());
node = result.iterateNext();
}➡
title: Harry Potter
Node: <title>Harry Potter</title>Evaluate string values directly:
import { DOMParserImpl as dom } from 'xmldom-ts';
import * as xpath from 'xpath-ts';
const xml = '<book><title>Harry Potter</title></book>';
const doc = new dom().parseFromString(xml);
const title = xpath.select('string(//title)', doc);
console.log(title);➡
Harry PotterNamespaces
import { DOMParserImpl as dom } from 'xmldom-ts';
import * as xpath from 'xpath-ts';
const xml = "<book><title xmlns='myns'>Harry Potter</title></book>";
const doc = new dom().parseFromString(xml);
const node = xpath.select("//*[local-name(.)='title' and namespace-uri(.)='myns']", doc)[0];
console.log(node.namespaceURI);➡
mynsNamespaces with easy mappings
import { DOMParserImpl as dom } from 'xmldom-ts';
import * as xpath from 'xpath-ts';
const xml = "<book xmlns:bookml='http://example.com/book'><bookml:title>Harry Potter</bookml:title></book>";
const select = xpath.useNamespaces({ bookml: 'http://example.com/book' });
console.log(select('//bookml:title/text()', doc)[0].nodeValue);➡
Harry PotterDefault namespace with mapping
import { DOMParserImpl as dom } from 'xmldom-ts';
import * as xpath from 'xpath-ts';
const xml = "<book xmlns='http://example.com/book'><title>Harry Potter</title></book>";
const select = xpath.useNamespaces({ bookml: 'http://example.com/book' });
console.log(select('//bookml:title/text()', doc)[0].nodeValue);➡
Harry PotterAttributes
import { DOMParserImpl as dom } from 'xmldom-ts';
import * as xpath from 'xpath-ts';
const xml = "<book author='J. K. Rowling'><title>Harry Potter</title></book>";
const doc = new dom().parseFromString(xml);
const author = xpath.select1('/book/@author', doc).value;
console.log(author);➡
J. K. RowlingDeveloping and Testing
Download
git clone 'https://github.com/EagleoutIce/xpath-ts'
cd xpath-tsInstall
npm installBuild
npm run buildYou will get the transpiled code under '/dist/lib' and typings under '/dist/types'.
Test
Run standard tests with Mocha + Chai testing framework
npm testAuthors
- Cameron McCormack - Initial work - blog
- Yaron Naveh - blog
- goto100
- Jimmy Rishe
- Thomas Weinert
- Matus Zamborsky - TypeScript rewrite - Backslash47
- Florian Sihler - port to TypeScript5 - EagleoutIce
- Others - others
Licence
This project is licensed under the MIT License - see the LICENCE.md file for details.