P3X GitList

17a24607

[//]: #@corifeus-header [![NPM](https://nodei.co/npm/p3x-xml2json.png?downloads=true&downloadRank=true)](https://www.npmjs.com/package/p3x-xml2json/) [![Donate for Corifeus / P3X](https://img.shields.io/badge/Donate-Corifeus-003087.svg)](https://paypal.me/patrikx3) [![Contact Corifeus / P3X](https://img.shields.io/badge/Contact-P3X-ff9900.svg)](https://www.patrikx3.com/en/front/contact) [![Corifeus @ Facebook](https://img.shields.io/badge/Facebook-Corifeus-3b5998.svg)](https://www.facebook.com/corifeus.software) [![Build Status](https://api.travis-ci.com/patrikx3/xml2json.svg?branch=master)](https://travis-ci.com/patrikx3/xml2json) [![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m780749701-41bcade28c1ea8154eda7cca.svg)](https://uptimerobot.patrikx3.com/)

2ee12fcb

# Converts xml to json and vice-versa, using node-expat. v2019.10.111

17a24607

**Note about versioning:** Versions are cut in Major.Minor.Patch schema. Major is always the current year. Minor is either 4 (January - June) or 10 (July - December). Patch is incremental by every build. If there is a breaking change, it should be noted in the readme. **Bugs are evident™ - MATRIX️** ### Node Version Requirement ``` >=10.16.0 ``` ### Built on Node ``` v12.7.0 ``` The ```async``` and ```await``` keywords are required. Install NodeJs: https://nodejs.org/en/download/package-manager/ # Description [//]: #@corifeus-header:end

0980a29a

# Simple XML2JSON Parser

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

2926b222

refer to its [documentation](https://github.com/astro/node-expat/blob/master/README.md#windows).

d59819d6

115e66f6

## Installation ```

17a24607

$ npm install p3x-xml2json

115e66f6

```

440a652d

e982acb0

## Usage

ef331c47

```javascript

17a24607

var parser = require('p3x-xml2json');

6a202d68

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

2604658c

17a24607

[//]: #@corifeus-footer --- 🙏 This is an open-source project. Star this repository, if you like it, or even donate to maintain the servers and the development. Thank you so much! Possible, this server, rarely, is down, please, hang on for 15-30 minutes and the server will be back up. All my domains ([patrikx3.com](https://patrikx3.com) and [corifeus.com](https://corifeus.com)) could have minor errors, since I am developing in my free time. However, it is usually stable. ---

2ee12fcb

[**P3X-XML2JSON**](https://pages.corifeus.com/xml2json) Build v2019.10.111

17a24607

[![Donate for Corifeus / P3X](https://img.shields.io/badge/Donate-Corifeus-003087.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QZVM4V6HVZJW6) [![Contact Corifeus / P3X](https://img.shields.io/badge/Contact-P3X-ff9900.svg)](https://www.patrikx3.com/en/front/contact) [![Like Corifeus @ Facebook](https://img.shields.io/badge/LIKE-Corifeus-3b5998.svg)](https://www.facebook.com/corifeus.software) ## P3X Sponsors

2604658c

17a24607

[IntelliJ - The most intelligent Java IDE](https://www.jetbrains.com/?from=patrikx3) [![JetBrains](https://cdn.corifeus.com/assets/svg/jetbrains-logo.svg)](https://www.jetbrains.com/?from=patrikx3) [![NoSQLBooster](https://cdn.corifeus.com/assets/png/nosqlbooster-70x70.png)](https://www.nosqlbooster.com/)

2604658c

17a24607

[The Smartest IDE for MongoDB](https://www.nosqlbooster.com)

2604658c

17a24607

[//]: #@corifeus-footer:end