README.md
[//]: #@corifeus-header
[](https://www.npmjs.com/package/p3x-xml2json/)
[](https://paypal.me/patrikx3) [](https://www.patrikx3.com/en/front/contact) [](https://www.facebook.com/corifeus.software) [](https://github.com/patrikx3/xml2json/actions?query=workflow%3Abuild)
[](https://stats.uptimerobot.com/9ggnzcWrw)
# Converts xml to json and vice-versa, using node-expat v2023.10.125
**Bugs are evident™ - MATRIX️**
### NodeJS LTS is supported
### Built on NodeJs version
```txt
v20.5.0
```
# Description
[//]: #@corifeus-header:end
## Simple XML2JSON Parser
### The info about the fork
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.
Besides, I have upgraded all packages to the latest versions.
## Verbose description
It does not parse the following elements:
* CDATA sections (*)
* Processing instructions
* XML declarations
* Entity declarations
* Comments
This module uses node-expat which will require extra steps if you want to get it installed on Windows. Please
refer to its [documentation](https://github.com/astro/node-expat/blob/master/README.md#windows).
## Installation
```bash
$ npm install p3x-xml2json
```
## Usage
```javascript
var parser = require('p3x-xml2json');
var xml = "<foo attr=\"value\">bar</foo>";
console.log("input -> %s", xml)
// xml to json
var json = parser.toJson(xml);
console.log("to json -> %s", json);
// json to xml
var xml = parser.toXml(json);
console.log("back to xml -> %s", xml)
```
## API
```javascript
parser.toJson(xml, options);
```
```javascript
parser.toXml(json);
```
### Options object for `toJson`
Default values:
```javascript
var options = {
object: false,
reversible: false,
coerce: false,
sanitize: true,
trim: true,
arrayNotation: false
alternateTextNode: false
};
```
* **object:** Returns a Javascript object instead of a JSON string
* **reversible:** Makes the JSON reversible to XML (*)
* **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.
* **trim:** Removes leading and trailing whitespaces as well as line terminators in element values.
* **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.
* **sanitize:** Sanitizes the following characters present in element values:
```javascript
var chars = {
'<': '<',
'>': '>',
'(': '(',
')': ')',
'#': '#',
'&': '&',
'"': '"',
"'": '''
};
```
* **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.
### Options object for `toXml`
Default values:
```javascript
var options = {
sanitize: false,
ignoreNull: false
};
```
* `sanitize: false` is the default option to behave like previous versions
* **ignoreNull:** Ignores all null values
(*) xml2json tranforms CDATA content to JSON, but it doesn't generate a reversible structure.
[//]: #@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.
**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.
---
[**P3X-XML2JSON**](https://corifeus.com/xml2json) Build v2023.10.125
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QZVM4V6HVZJW6) [](https://www.patrikx3.com/en/front/contact) [](https://www.facebook.com/corifeus.software)
[//]: #@corifeus-footer:end
