Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pladaria/xml-lexer
Javascript XML Lexer
https://github.com/pladaria/xml-lexer
Last synced: about 2 months ago
JSON representation
Javascript XML Lexer
- Host: GitHub
- URL: https://github.com/pladaria/xml-lexer
- Owner: pladaria
- License: mit
- Created: 2016-03-25T10:18:28.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-17T08:53:13.000Z (about 8 years ago)
- Last Synced: 2024-10-14T14:34:12.368Z (3 months ago)
- Language: JavaScript
- Size: 34.2 KB
- Stars: 13
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Simple JavaScript Lexer for XML documents
## Features
- Very small, fast and simple! (~250 sloc)
- Event driven API (SAX-like)
- Works in Browser, WebWorkers, ServiceWorkers, Node.js or React Native
- Fault tolerant
- Handles CDATA
- Easy to extend and fine tune (state machine is exposed in Lexer instances)
If you are looking for a [XML Reader/Parser to convert XML documents into Javascript objects](https://github.com/pladaria/xml-reader), check my other projects:
- [xml-reader](https://github.com/pladaria/xml-reader)
- [xml-query](https://github.com/pladaria/xml-query)
## Install
```bash
npm install --save xml-lexer
```
## Examples
### Happy case
```javascript
const lexer = require('xml-lexer').create();
const xml =
`
Hello, world!
`;
lexer.on('data', (data) => console.log(data));
lexer.write(xml);
/*
Console output:
{ type: 'open-tag', value: 'hello' }
{ type: 'attribute-name', value: 'color' }
{ type: 'attribute-value', value: 'blue' }
{ type: 'open-tag', value: 'greeting' }
{ type: 'data', value: 'Hello, world!' }
{ type: 'close-tag', value: 'greeting' }
{ type: 'close-tag', value: 'hello' }
*/
```
### Chunked processing
```javascript
const lexer = require('xml-lexer').create();
const chunk1 = `Hello, world!`;
lexer.on('data', (data) => console.log(data));
lexer.write(chunk1);
lexer.write(chunk2);
/*
Console output:
{ type: 'open-tag', value: 'hello' }
{ type: 'open-tag', value: 'greeting' }
{ type: 'data', value: 'Hello, world!' }
{ type: 'close-tag', value: 'greeting' }
{ type: 'close-tag', value: 'hello' }
*/
```
### Document with errors
```javascript
const lexer = require('xml-lexer').create();
lexer.on('data', (data) => console.log(data));
lexer.write(`<hi`);
/*
Console output (note the open-tag value):
{ type: 'open-tag', value: ' {};
lexer.stateMachine[Lexer.State.tagName][Lexer.Action.error] = () => {};
lexer.on('data', (data) => console.log(data));
lexer.write(`<hi`);
/*
Console output (note the fixed open-tag value):
{ type: 'open-tag', value: 'hello' }
{ type: 'data', value: 'hi' }
{ type: 'close-tag', value: 'hello' }
*/
```
## License
MIT