P3X GitList

0980a29a

# Simple XML2JSON Parser

8d60f900

[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/buglabs/node-xml2json?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

b143d11c

[![Build Status](https://travis-ci.org/buglabs/node-xml2json.svg?branch=master)](https://travis-ci.org/buglabs/node-xml2json)

6a202d68

e982acb0

It does not parse the following elements:

440a652d

5250374c

* CDATA sections (*)

440a652d

* Processing instructions * XML declarations * Entity declarations * Comments

d59819d6

This module uses node-expat which will require extra steps if you want to get it installed on Windows. Please

390e9cc1

refer to its [documentation](http://node-xmpp.org/doc/expat.html#installing-on-windows?). Also, please be aware of known issues installing node-expat on Windows: https://github.com/node-xmpp/node-expat/issues?utf8=✓&q=is%3Aissue+is%3Aopen+windows

d59819d6

115e66f6

## Installation ``` $ npm install xml2json ```

440a652d

e982acb0

## Usage

ef331c47

```javascript

6a202d68

var parser = require('xml2json');

712cc3c7

var xml = "<foo attr=\"value\">bar</foo>"; console.log("input -> %s", xml)

4d5246c6

// xml to json

712cc3c7

var json = parser.toJson(xml); console.log("to json -> %s", json);

4d5246c6

// json to xml

712cc3c7

var xml = parser.toXml(json); console.log("back to xml -> %s", xml)

6a202d68

```

712cc3c7

5250374c

## API

115e66f6

ef331c47

```javascript

5250374c

parser.toJson(xml, options); ```

ef331c47

```javascript

ce867785

parser.toXml(json);

5250374c

```

115e66f6

34616418

### Options object for `toJson`

115e66f6

6aefda07

Default values:

ef331c47

```javascript

5250374c

var options = {

6aefda07

object: false, reversible: false,

b143d11c

coerce: false,

6aefda07

sanitize: true,

e982acb0

trim: true, arrayNotation: false

34d9f9a9

alternateTextNode: false

6aefda07

};

115e66f6

```

5250374c

* **object:** Returns a Javascript object instead of a JSON string * **reversible:** Makes the JSON reversible to XML (*)

9d4e812a

* **coerce:** Makes type coercion. i.e.: numbers and booleans present in attributes and element values are converted from string to its correspondent data types. Coerce can be optionally defined as an object with specific methods of coercion based on attribute name or tag name, with fallback to default coercion.

5250374c

* **trim:** Removes leading and trailing whitespaces as well as line terminators in element values.

34d9f9a9

* **arrayNotation:** XML child nodes are always treated as arrays NB: you can specify a selective array of nodes for this to apply to instead of the whole document.

d17bb4d4

* **sanitize:** Sanitizes the following characters present in element values:

5250374c

ef331c47

```javascript

e982acb0

var chars = {

6aefda07

'<': '<', '>': '>', '(': '(', ')': ')', '#': '#', '&': '&', '"': '"', "'": ''' };

5250374c

```

34d9f9a9

* **alternateTextNode:** Changes the default textNode property from $t to _t when option is set to true. Alternatively a string can be specified which will override $t to what ever the string is.

5250374c

34616418

### Options object for `toXml`

5250374c

34616418

Default values: ```javascript var options = {

2d87cdb1

sanitize: false, ignoreNull: false

34616418

}; ```

2d87cdb1

* `sanitize: false` is the default option to behave like previous versions * **ignoreNull:** Ignores all null values

5250374c

(*) xml2json tranforms CDATA content to JSON, but it doesn't generate a reversible structure.

6a202d68

## License

2604658c

(The MIT License)

712cc3c7

2604658c

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS

e982acb0

IN THE SOFTWARE.