tabshift/xml-streamer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

minor update to README.md

Browse Source
This commit is contained in:
Sai1919
2016-11-11 16:11:13 +05:30
parent ce56469497
commit e73de0bbb9
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -81,7 +81,7 @@ npm install xml-streamer
}) })
}()) }())
// 2. By passing the resourcePath as shown in 2 method and reading data by calling `read` method instead listening for data events. // 3. By passing the resourcePath as shown in 2 method and reading data by calling `read` method instead listening for data events.
(function () { (function () {
"use strict"; "use strict";
@@ -144,6 +144,7 @@ npm install xml-streamer
if you are interested in `subitem` nodes then resourcePath would be: `/items/item/subitem` if you are interested in `subitem` nodes then resourcePath would be: `/items/item/subitem`
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
@@ -162,7 +163,8 @@ npm install xml-streamer
``` ```
`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: '_'`