RSS Git Download  Clone
..
  fixtures Add toJson arrayNotation option 11 years ago
  .gitignore 11B Adds basic sanitization and re-rewrites coercion and trimming 12 years ago
  coerce-overhead.js 503B Refactor for perf sake. Add perf tests. 12 years ago
  test-array-notation.js 397B Add toJson arrayNotation option 11 years ago
  test-coerce.js 996B Adds basic sanitization and re-rewrites coercion and trimming 12 years ago
  test-reorder.js 519B Add test for the json2xml property "reorder" case. 12 years ago
  test-space.js 1kB add json2xml test cases 12 years ago
  test.js 3kB Add toJson arrayNotation option 11 years ago
  README.md
# Simple SAX-based XML2JSON Parser. It does not parse the following elements: * CDATA sections (*) * Processing instructions * XML declarations * Entity declarations * Comments ## Installation ``` $ npm install xml2json ``` ## Usage ```javascript var parser = require('xml2json'); var xml = "<foo>bar</foo>"; var json = parser.toJson(xml); //returns a string containing the JSON structure by default console.log(json); ``` ## API ```javascript parser.toJson(xml, options); ``` ```javascript parser.toXml(json, options); ``` ### Options object Default values: ```javascript var options = { object: false, reversible: false, coerce: true, 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. * **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: ```javascript var chars = { '<': '&lt;', '>': '&gt;', '(': '&#40;', ')': '&#41;', '#': '&#35;', '&': '&amp;', '"': '&quot;', "'": '&apos;' }; ``` (*) xml2json tranforms CDATA content to JSON, but it doesn't generate a reversible structure. ## License (The MIT License) Copyright 2012 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.