RSS Git Download  Clone
  bin add executable 8 years ago
  lib Makes sure & is sanitized first. 6 years ago
  test Updates coercion fixtures to fix broken tests. 6 years ago
  .editorconfig 242B Adds editorconfig and fixes code formatting 6 years ago
  .gitignore 30B gitignores .DS_Store 8 years ago
  .npmignore 13B bump version 10 years ago
  Makefile 65B Merges #58 6 years ago 3kB Add: ability to specify custom coercion methods by name If `options.coerce` is an object, coercion is `true` but any attribute/tag first checks the coercion object for a custom function under the tag/attribute name, before falling back to the default coercion. 6 years ago
  index.js 35B initial commit 10 years ago
  package.json 517B Bumps minor version to correct issue when publishing to NPM 6 years ago
# Simple XML2JSON Parser [![Gitter]( Chat.svg)]( 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 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 object for `toJson` 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. 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: ```javascript var chars = { '<': '&lt;', '>': '&gt;', '(': '&#40;', ')': '&#41;', '#': '&#35;', '&': '&amp;', '"': '&quot;', "'": '&apos;' }; ``` ### Options object for `toXml` Default values: ```javascript 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 2014 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.