update README.md
This commit is contained in:
12
README.md
12
README.md
@@ -3,7 +3,7 @@
|
|||||||
[](https://travis-ci.org/Sai1919/xml-streamer)
|
[](https://travis-ci.org/Sai1919/xml-streamer)
|
||||||
## Motivation
|
## Motivation
|
||||||
|
|
||||||
You use [Node.js](https://nodejs.org) for speed? You process XML streams? Then you want the fastest XML to JS parser: [xml-streamer]!
|
You use [Node.js](https://nodejs.org) for speed? You process XML streams? Then you want the fastest XML to JS parser: xml-streamer
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
@@ -79,24 +79,28 @@ npm install xml-streamer
|
|||||||
if you are interested in `items` nodes then resourcePath would be: `/items`
|
if you are interested in `items` nodes then resourcePath would be: `/items`
|
||||||
|
|
||||||
* `emitOnNodeName`: `Type: Boolean` Optional field. Set this to true if you want to listen on node names instead of data event. `default: false`
|
* `emitOnNodeName`: `Type: Boolean` Optional field. Set this to true if you want to listen on node names instead of data event. `default: false`
|
||||||
|
|
||||||
// Ex: consider the above XML snippet
|
// Ex: consider the above XML snippet
|
||||||
if you are interested in `item` nodes. You can listen for `data` event by default to get those nodes in JS object form
|
|
||||||
```javascript
|
```javascript
|
||||||
|
if you are interested in `item` nodes. You can listen for `data` event by default to get those nodes in JS object form
|
||||||
|
|
||||||
parser.on('data', function (data) {
|
parser.on('data', function (data) {
|
||||||
// item nodes as javascipt objects
|
// item nodes as javascipt objects
|
||||||
})
|
})
|
||||||
```
|
|
||||||
or else you can set `emitOnNodeName: true` and listen on node names like
|
or else you can set `emitOnNodeName: true` and listen on node names like
|
||||||
```javascript
|
|
||||||
parser.on('item', function (data) {
|
parser.on('item', function (data) {
|
||||||
// item nodes as javascipt objects
|
// item nodes as javascipt objects
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
`NOTE:` when you set `emitOnNodeName:true` "data" events are emitted normally. So make sure you don't listen for both the events.
|
`NOTE:` when you set `emitOnNodeName:true` "data" events are emitted normally. So make sure you don't listen for both the events.
|
||||||
|
|
||||||
* `attrsKey`: `Type: String` Optional field. pass the value with which you want to reference attributes of a node in its object form. `default: '$'`
|
* `attrsKey`: `Type: String` Optional field. pass the value with which you want to reference attributes of a node in its object form. `default: '$'`
|
||||||
|
|
||||||
* `textKey`: `Type: String` Optional field. pass the value with which you want to reference node value in its object form. `default: '_'`
|
* `textKey`: `Type: String` Optional field. pass the value with which you want to reference node value in its object form. `default: '_'`
|
||||||
|
|
||||||
// In the above XML snippet `subitem` node will look like this after converted to javascript object
|
// In the above XML snippet `subitem` node will look like this after converted to javascript object
|
||||||
```javascript
|
```javascript
|
||||||
{
|
{
|
||||||
|
|||||||
Reference in New Issue
Block a user