npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

slimdom-sax-parser

v1.5.3

Published

Parse an XML string to a light-weight spec-compliant document object model, for browser and Node

Downloads

4,469

Readme

slimdom-sax-parser

Parses XML to a slimdom document using saxes. slimdom is a fast, tiny, standards-compliant XML DOM implementation for browser and node.

  • Parses text, elements, attributes, processing instructions, comments and CDATA
  • Supports namespaces
  • Works in NodeJS and the browser

Exports

Has two named exports:

  • async (function) Asynchronously return a slimdom Document for the given XML string or Readable stream.
  • sync (function) Synchronously return a slimdom Document for the given XML string:
  • slimdom (slimdom) A reference to the lib this parser is built around, as a convenience.

The shape of the async function is as follows;

function async(
	xml: string | stream.Readable,
	options?: saxes.SaxesOptions & {
		additionalEntities?: {
			[entityName: string]: string;
		};
	}
): Promise<slimdom.Document>;

The shape of the sync function is as follows;

function sync(
	xml: string,
	options?: saxes.SaxesOptions & {
		additionalEntities?: {
			[entityName: string]: string;
		};
	}
): slimdom.Document;

See also saxes.SaxesOptions and the standard DOM API.

Usage

import { async } from 'slimdom-sax-parser';

const dom = await async('<xml foo="bar" />');
import { sync } from 'slimdom-sax-parser';

const dom = sync('<xml foo="bar" />');

Examples

Modify the XML DOM:

import { sync } from 'slimdom-sax-parser';

const document = sync(`<foo />`);

document.documentElement.setAttribute('bar', 'baz');
// document.documentElement.hasAttribute('bar') === true

Use with an XPath engine (fontoxpath):

import { sync } from 'slimdom-sax-parser';
import { evaluateXPath } from 'fontoxpath';

const document = sync(`<foo><bar /><baz /></foo>`);
const childNodeNames = evaluateXPath('/foo/*/name()', document);
// childNodeNames equals ['bar', 'baz']

Use source code position tracking:

import { slimdom, sync } from 'slimdom-sax-parser';

const xml = '<example><child-element /></example>';

const document = sync(xml, { position: true });
// document instanceof slimdom.Document === true

const childElement = document.documentElement.firstChild;
// childElement instanceof slimdom.Element === true

const position = childElement.position;
// xml.substring(position.start, position.end) === '<child-element />'

Transform a XML file:

import fs from 'fs';
import { async, slimdom } from 'slimdom-sax-parser';
import { evaluateXPathToNodes } from 'fontoxpath';

async function transform(filePath) {
	const xmlStream = fs.createReadStream(filePath);
	const document = await async(xmlStream);

	const barNodes = evaluateXPathToNodes('//bar/*', document);
	for (const barNode of barNodes) {
		barNode.setAttribute('bar', 'baz');
	}

	await fs.promises.writeFile(filePath, slimdom.serializeToWellFormedString(document));
}

transform('./file.xml');

License

Copyright (c) 2019 Wybe Minnebo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.