p3x Done
Uptime Robot ratio (30 days)      

Converts xml to json and vice-versa, using node-expat

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 .


$ npm install p3x-xml2json


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)


parser.toJson(xml, options);

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.

onenoteGithub onenoteredis-uiGithub redis-uiangular-compileGithub angular-compilegitlistGithub gitlistramdiskGithub ramdiskfreenomGithub freenomopenwrt-insomniaGithub openwrt-insomniaredis-ui-serverGithub redis-ui-serversystemd-managerGithub systemd-managerredis-ui-materialGithub redis-ui-materialxml2jsonGithub xml2jsoncorifeusGithub corifeushtml-pdfGithub html-pdfangular-http-cache-interceptorGithub angular-http-cache-interceptorverdaccio-cliGithub verdaccio-clibinary-search-closestGithub binary-search-closestcorifeus-app-web-pagesGithub corifeus-app-web-pagesgrunt-p3x-expressGithub grunt-p3x-expressjson2xls-worker-threadGithub json2xls-worker-threadtoolsGithub toolscorifeus-builderGithub corifeus-buildercorifeus-utilsGithub corifeus-utils