https://github.com/manojc/xtagger
A simple node package to get the XML structure of xml file using streams!
https://github.com/manojc/xtagger
sax sax-parser stream xml xml-node xml-parser xml-parsing
Last synced: 2 months ago
JSON representation
A simple node package to get the XML structure of xml file using streams!
- Host: GitHub
- URL: https://github.com/manojc/xtagger
- Owner: manojc
- License: mit
- Created: 2018-08-17T20:44:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-05T19:29:01.000Z (over 6 years ago)
- Last Synced: 2024-10-30T01:37:40.381Z (6 months ago)
- Topics: sax, sax-parser, stream, xml, xml-node, xml-parser, xml-parsing
- Language: TypeScript
- Homepage: https://runkit.com/manojc/5b8c39bc808c3400127a2868
- Size: 6.71 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/manojc/xtagger)
# Why [xtagger](https://www.npmjs.com/package/xtagger)?
`xtagger` is a simple node package based on [sax](https://www.npmjs.com/package/sax) to get the XML structure of xml file using streams!
This package is useful in case you want to read a huge xml file in chunks. There are few npm packages like [xml-flow](https://www.npmjs.com/package/xml-flow) & [xml-stream](https://www.npmjs.com/package/xml-stream) which accept a repeating node to parse one xml node at a time using streams. The problem here is - **how to find the appropriate repeating xml node?**
`xtagger` helps you to find the appropriate node as it outputs the xml structure using streams.
Simply do **`npm i xtagger --save`** to install the package.
## APIs
`xtagger` exposes 2 properties -
### **getXTagger(options)**
This property is a `function` that triggers `xtagger.` It returns a `duplex stream` that can be piped with a readbale stream.
`options` manipulates the behavior of xml streamer. Check [sax options](https://www.npmjs.com/package/sax#arguments) for all the details.
### xTaggerEvent: EventEmitter
`xtagger` fires an event after successful data processing. `xTaggerEvent` listens to the fired event & the event handler function provides the generated xml structure.
## Example
### Typescript
```javascript
import { createReadStream } from "fs";
import { getXTagger, xTaggerEvent } from "xtagger";
// options for sax stream API with default values
const options: any = {
"strict": false,
"trim": false,
"normalize": false,
"lowercase": false,
"xmlns": false,
"noscript": false,
"position": false
};
xTaggerEvent.once("xtagger", (response: any) => console.log(response));
createReadStream("file-path").pipe(getXTagger(options));
```
### Javascript
```javascript
const fs = require("fs");
const xtagger = require("xtagger");
// options for sax stream API with default values
const options = {
"strict": false,
"trim": false,
"normalize": false,
"lowercase": false,
"xmlns": false,
"noscript": false,
"position": false
};
xtagger.xTaggerEvent.once("xtagger", (response) => console.log(response));
fs.createReadStream("file-path").pipe(xtagger.getXTagger(options));
```
### Sample XML
```xml
Belgian Waffles
$5.95
Two of our famous Belgian Waffles with plenty of real maple syrup
650
Strawberry Belgian Waffles
$7.95
Light Belgian waffles covered with strawberries and whipped cream
900
```
### Output
In case of above `XML`, the output structure would look like -
```javascript
{
"breakfast_menu": { "1": 1 },
"food": { "2": 2 },
"name": { "3": 2 },
"price": { "3": 2 },
"description": { "3": 2 },
"calories": { "3": 2}
}
```
The top level keys represent the tag names. Every `tage name` is an object where key represents the `hierarchy` of the tag in xml strcture whereas value is the count of the `tag name` in the `XML` file.
The generalised structure format looks like this -
```javascript
structure: { [name: string]: { [hierarchy: number]: number } };
```
In case of multiple occurance of the same `tag name` at different hierarchy levels, `tag name` gets following `JSON` structure to provide the distribution of the counts at different hierarchy levels -
```javascript
{
"breakfast_menu": { "1": 1 },
"food": { "2": 2 },
"name": { "3": 2 },
"price": { "3": 2 },
"description": { "3": 2, "4": 2 }, // description tag is present at level 3 & 4
"calories": { "3": 2}
}
```
## Demo
Checkout the [repository](https://github.com/manojc/xtagger). Install dependencies with command **`npm i`** & run **`npm start`** command to start the demo.
## Test
Checkout the [repository](https://github.com/manojc/xtagger). Install dependencies with command **`npm i`** & run **`npm run test`** command to run the tests.
---
- Author - Manoj Chalode ([manojc](https://github.com/manojc))
- Copyright - [email protected]