Skip to content

Converts XML to JSON using node-expat

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
LICENSE.old
Notifications You must be signed in to change notification settings

patrikx3/xml2json

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

NPM Donate for PatrikX3 / P3X Contact Corifeus / P3X Corifeus @ Facebook Uptime ratio (90 days)

πŸ” Converts xml to json and vice-versa, using node-expat v2025.4.122

🌌 Bugs are evidentβ„’ - MATRIX️
🚧 This project is under active development!
πŸ“’ We welcome your feedback and contributions.

NodeJS LTS is supported

πŸ› οΈ Built on NodeJs version

v22.13.1

πŸ“ Description

Simple XML2JSON Parser

The info about the fork

The buglabs#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 =  {
    '<': '&lt;',
    '>': '&gt;',
    '(': '&#40;',
    ')': '&#41;',
    '#': '&#35;',
    '&': '&amp;',
    '"': '&quot;',
    "'": '&apos;'
};
  • 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.


πŸš€ Quick and Affordable Web Development Services

If you want to quickly and affordably develop your next digital project, visit corifeus.eu for expert solutions tailored to your needs.


🌐 Powerful Online Networking Tool

Discover the powerful and free online networking tool at network.corifeus.com.

πŸ†“ Free
Designed for professionals and enthusiasts, this tool provides essential features for network analysis, troubleshooting, and management.
Additionally, it offers tools for:

  • πŸ“‘ Monitoring TCP, HTTP, and Ping to ensure optimal network performance and reliability.
  • πŸ“Š Status page management to track uptime, performance, and incidents in real time with customizable dashboards.

All these features are completely free to use.


❀️ 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!


🌍 About My Domains

All my domains, including patrikx3.com, corifeus.eu, 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 v2025.4.122

NPM Donate for PatrikX3 / P3X Contact Corifeus / P3X Like Corifeus @ Facebook

About

Converts XML to JSON using node-expat

Topics

Resources

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
LICENSE.old

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%