P3X GitList

17a24607

[//]: #@corifeus-header

a5d487ea

d2120a91

[![NPM](https://img.shields.io/npm/v/p3x-xml2json.svg)](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) [![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m780749701-41bcade28c1ea8154eda7cca.svg)](https://stats.uptimerobot.com/9ggnzcWrw)

17a24607

40e2824d

# Converts xml to json and vice-versa, using node-expat v2024.10.102

a5d487ea

e1377bf1

a5d487ea

**Bugs are evident™ - MATRIX️**

17a24607

c7dde871

### NodeJS LTS is supported ### Built on NodeJs version

3819030b

```txt

40e2824d

v22.3.0

a5d487ea

```

17a24607

a5d487ea

# Description

17a24607

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

6a202d68

05816fc0

## Simple XML2JSON Parser ### The info about the fork

e67cc9aa

The https://github.com/buglabs/node-xml2json/pull/180 maintainers (`buglabs`, no e-mail, no GitHub) are not responsive. So, I created a small fix, that works perfectly, it is named as `p3x-xml2json`. It is the same as the original, just works with NodeJs 12. I am open to merge pull requests. I maintain. Please free, to contact me.

23e91998

Besides, I have upgraded all packages to the latest versions.

e67cc9aa

## Verbose description

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

e67cc9aa

```bash

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 ---

deb2377b

## Support Our Open-Source Project ❤️ If you appreciate our work, consider starring this repository or making a donation to support server maintenance and ongoing development. Your support means the world to us—thank you!

17a24607

deb2377b

### Server Availability Our server may occasionally be down, but please be patient. Typically, it will be back online within 15-30 minutes. We appreciate your understanding.

a5d487ea

deb2377b

### About My Domains All my domains, including [patrikx3.com](https://patrikx3.com) and [corifeus.com](https://corifeus.com), are developed in my spare time. While you may encounter minor errors, the sites are generally stable and fully functional.

8c50c137

deb2377b

### Versioning Policy **Version Structure:** We follow a Major.Minor.Patch versioning scheme: - **Major:** Corresponds to the current year. - **Minor:** Set as 4 for releases from January to June, and 10 for July to December. - **Patch:** Incremental, updated with each build. **Important Changes:** Any breaking changes are prominently noted in the readme to keep you informed.

8c50c137

17a24607

---

deb2377b

40e2824d

[**P3X-XML2JSON**](https://corifeus.com/xml2json) Build v2024.10.102

a5d487ea

b8d22630

[![NPM](https://img.shields.io/npm/v/p3x-xml2json.svg)](https://www.npmjs.com/package/p3x-xml2json) [![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)

17a24607

a5d487ea

2604658c

17a24607

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