Skip to content
Converts XML to JSON using node-expat
JavaScript
Branch: master
Clone or download
Pull request Compare This branch is 14 commits ahead of buglabs:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
src
test
.editorconfig
.gitignore
.npmignore
.travis.yml
AUTHORS
Gruntfile.js
LICENSE
LICENSE.old
README.md
example.js
index.js
package.json
xml2json.iml

README.md

NPM

Donate for Corifeus / P3X Contact Corifeus / P3X Corifeus @ Facebook Build Status Uptime Robot ratio (30 days)

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

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.

Bugs are evident™ - MATRIX️

Node Version Requirement

>=10.16.0 

Built on Node

v12.7.0

The async and await keywords are required.

Install NodeJs:
https://nodejs.org/en/download/package-manager/

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 =  {
    '<': '&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.


🙏 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 and corifeus.com) could have minor errors, since I am developing in my free time. However, it is usually stable.


P3X-XML2JSON Build v2019.10.164

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

P3X Sponsors

IntelliJ - The most intelligent Java IDE

JetBrains NoSQLBooster

The Smartest IDE for MongoDB

You can’t perform that action at this time.