# saxophonist

> Extract elements from large XML files with node.js streams

Latest version **2.0.0** (published 2020-02-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install saxophonist
pnpm add saxophonist
yarn add saxophonist
bun add saxophonist
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-02-12 |
| First published | 2016-01-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Matteo Collina |
| Maintainers | matteo.collina |
| Keywords | sax, stream, element |

## Links

- npm: https://www.npmjs.com/package/saxophonist
- Repository: https://github.com/mcollina/saxophonist
- Homepage: https://github.com/mcollina/saxophonist#readme
- Issues: https://github.com/mcollina/saxophonist/issues
- npm.io page: https://npm.io/package/saxophonist

## Dependencies (3)

- [sax](https://npm.io/package/sax.md) ^1.1.4
- [inherits](https://npm.io/package/inherits.md) ^2.0.1
- [readable-stream](https://npm.io/package/readable-stream.md) ^3.5.0

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2020-02-12
- 1.0.0 — 2016-01-26

## README

# saxophonist

Extract elements from large XML files with node.js streams

## Usage

```js
'use strict'

var fs = require('fs')
var p = require('path')
var saxophonist = require('./')
var count = 0

console.time('parsing time')

fs.createReadStream(p.join(__dirname, 'wikipedia', '1.xml'))
  .pipe(saxophonist('page'))
  .on('data', function () {
    count++
  })
  .on('end', function () {
    console.timeEnd('parsing time')
    console.log('read', count, 'pages')
  })
```

The data format is:

```js
{
  path: ['a', 'path', 'to', 'page'], // the path in the XML document
  children: null, // or an array with elements like this
  attributes: {}, // object with all element attribute
  text: null // or string, containing the element text
}
```

## Acknowledgements

saxophonist is sponsored by [nearForm](http://nearform.com).

## License

MIT

---
_Source: https://npm.io/package/saxophonist · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._