Skip to content
Converts XML to JSON using node-expat
JavaScript
Find file
Latest commit df70a01 @c4milo c4milo Merge pull request #101 from robincsamuel/patch-1
Update README.md

README.md

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. Also, please be aware of known issues installing node-expat on Windows: https://github.com/node-xmpp/node-expat/issues?utf8=✓&q=is%3Aissue+is%3Aopen+windows

Installation

$ npm install xml2json

Usage

var parser = require('xml2json');

// xml to json
var xml = "<foo>bar</foo>";
var json = parser.toJson(xml); //returns a string containing the JSON structure by default
console.log(json);

// json to xml
var json = {
    root: {
        name: {'$t': 'John', id:'idx'} // $t for text, and all others will be attributes
    }
};
var xml = parser.toXml(xml); //returns xml  <root><name for="idx">John</name></root> 
console.log(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
};
  • 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
  • sanitize: Sanitizes the following characters present in element values:
var chars =  {
    '<': '&lt;',
    '>': '&gt;',
    '(': '&#40;',
    ')': '&#41;',
    '#': '&#35;',
    '&': '&amp;',
    '"': '&quot;',
    "'": '&apos;'
};

Options object for toXml

Default values:

var options = {
    sanitize: false
};

sanitize: false is the default option to behave like previous versions

(*) xml2json tranforms CDATA content to JSON, but it doesn't generate a reversible structure.

License

(The MIT License)

Copyright 2015 BugLabs. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.