Build a Node.js XML Document to JSON Object Parser or Converter Using xml2json Library in TypeScript Full Project For Beginners



Simple XML2JSON Parser

Gitter Build Status

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 xml2json


var parser = require('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 =  {
    <: &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.
See also  Build a Node.js Fill out Forms in PDF Document Using pdf-fill-form Library in Javascript Full Project For Beginners

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

Leave a Reply