p3x-xml2json
v2024.4.121
Published
Converts xml to json and vice-versa, using node-expat
Downloads
3,854
Readme
Converts xml to json and vice-versa, using node-expat v2024.4.121
Bugs are evident™ - MATRIX️
NodeJS LTS is supported
Built on NodeJs version
v22.1.0
Description
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.
Installation
$ npm install p3x-xml2json
Usage
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
parser.toJson(xml, options);
parser.toXml(json);
Options object for toJson
Default values:
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:
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:
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.
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!
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.
About My Domains
All my domains, including patrikx3.com and corifeus.com, are developed in my spare time. While you may encounter minor errors, the sites are generally stable and fully functional.
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.
P3X-XML2JSON Build v2024.4.121