1. module xml-js
   1. function xml-js.js2xml (js, options)
   2. function xml-js.json2xml (json, options)
   3. function xml-js.xml2js (xml, userOptions)
   4. function xml-js.xml2json (xml, userOptions)
   5. object xml-js.common
   6. object xml-js.index
2. module xml-js.common
   1. function xml-js.common.copyOptions (options)
   2. function xml-js.common.ensureFlagExists (item, options)
   3. function xml-js.common.ensureKeyExists (key, options)
   4. function xml-js.common.ensureSpacesExists (options)
   5. function xml-js.common.getCommandLineHelp (command, requiredArgs, optionalArgs)
   6. function xml-js.common.mapCommandLineArgs (requiredArgs, optionalArgs)
   7. function xml-js.common.sanitize (text)
3. module xml-js.index
   1. function xml-js.index.js2xml (js, options)
   2. function xml-js.index.json2xml (json, options)
   3. function xml-js.index.xml2js (xml, userOptions)
   4. function xml-js.index.xml2json (xml, userOptions)

module xml-js

function xml-js.js2xml (js, options)

• description and source-code

  js2xml = function (js, options) {
      'use strict';
      options = validateOptions(options);
      var xml = '';
      if (options.compact) {
          xml = writeElementsCompact(js, options, 0, true);
      } else {
          if (js[options.declarationKey]) {
              xml += writeDeclaration(js[options.declarationKey], options);
          }
          if (js[options.elementsKey] && js[options.elementsKey].length) {
              xml += writeElements(js[options.elementsKey], options, 0, !xml);
          }
      }
      return xml;
  }

• example usage

  n/a

function xml-js.json2xml (json, options)

• description and source-code

  json2xml = function (json, options) {
      'use strict';
      if (json instanceof Buffer) {
          json = json.toString();
      }
      var js = null;
      if (typeof (json) === 'string') {
          try {
              js = JSON.parse(json);
          } catch (e) {
              throw new Error("The JSON structure is invalid");
          }
      } else {
          js = json;
      }
      return js2xml(js, options);
  }

• example usage

  ...
  
  To convert JavaScript object to XML text, use `js2xml()`. To convert JSON text to XML text, use `json2xml()`.
  
  ```js
  var convert = require('xml-js');
  var json = require('fs').readFileSync('test.json', 'utf8');
  var options = {ignoreText: true, spaces: 4};
  var result = convert.json2xml(json, options);
  console.log(result);
  ```
  
  ### Options for Converting JS object / JSON → XML
  
  The below options are applicable for both `js2xml()` and `json2xml()` functions.
  ...

function xml-js.xml2js (xml, userOptions)

• description and source-code

  xml2js = function (xml, userOptions) {
  
      var parser = pureJsParser ? sax.parser(true, {}) : parser = new expat.Parser('UTF-8');
      var result = {};
      currentElement = result;
  
      options = validateOptions(userOptions);
  
      if (pureJsParser) {
          parser.onopentag = onStartElement;
          parser.ontext = onText;
          parser.oncomment = onComment;
          parser.onclosetag = onEndElement;
          parser.onerror = onError;
          parser.oncdata = onCdata;
          parser.onprocessinginstruction = onDeclaration;
      } else {
          parser.on('startElement', onStartElement);
          parser.on('text', onText);
          parser.on('comment', onComment);
          parser.on('endElement', onEndElement);
          parser.on('error', onError);
          //parser.on('startCdata', onStartCdata);
          //parser.on('endCdata', onEndCdata);
          //parser.on('entityDecl', onEntityDecl);
      }
  
      if (pureJsParser) {
          parser.write(xml).close();
      } else {
          if (!parser.parse(xml)) {
              throw new Error('XML parsing error: ' + parser.getError());
          }
      }
  
      if (result[options.elementsKey]) {
          var temp = result[options.elementsKey];
          delete result[options.elementsKey];
          result[options.elementsKey] = temp;
          delete result.text;
      }
  
      return result;
  
  }

• example usage

  ...
  
  To convert XML text to JavaScript object, use `xml2js()`. To convert XML text to JSON text, use `xml2json()`.
  
  ```js
  var convert = require('xml-js');
  var xml = require('fs').readFileSync('test.xml', 'utf8');
  var options = {ignoreText: true, alwaysChildren: true};
  var result = convert.xml2js(xml, options); // or convert.xml2json(xml, options)
  console.log(result);
  ```
  
  ### Options for Converting XML → JS object / JSON
  
  The below options are applicable for both `xml2js()` and `xml2json()` functions.
  ...

function xml-js.xml2json (xml, userOptions)

• description and source-code

  xml2json = function (xml, userOptions) {
      'use strict';
      var options, js, json, parentKey;
      options = validateOptions(userOptions);
      js = xml2js(xml, options);
      parentKey = 'compact' in options && options.compact ? '_parent' : 'parent';
      if ('addParent' in options && options.addParent) {
          json = JSON.stringify(js, function (k, v) { return k === parentKey? '_' : v; }, options.spaces);
      } else {
          json = JSON.stringify(js, null, options.spaces);
      }
      return json.replace(/\u2028/g, '\\u2028').replace(/\u2029/g, '\\u2029');
  }

• example usage

  ...
  var xml =
  '<?xml version="1.0" encoding="utf-8"?>' +
  '<note importance="high" logged="true">' +
  '    <title>Happy</title>' +
  '    <todo>Work</todo>' +
  '    <todo>Play</todo>' +
  '</note>';
  var result1 = convert.xml2json(xml, {compact: true, spaces: 4});
  var result2 = convert.xml2json(xml, {compact: false, spaces: 4});
  console.log(result1, '\n', result2);
  ```
  
  To see the result of this code, see the output above in *Synopsis* section.
  
  Or [run and edit](https://runkit.com/587874e079a2f60013c1f5ac/587874e079a2f60013c1f5ad) this code live in the browser.
  ...

module xml-js.common

function xml-js.common.copyOptions (options)

• description and source-code

  copyOptions = function (options) {
      var key, copy = {};
      for (key in options) {
          if (options.hasOwnProperty(key)) {
              copy[key] = options[key];
          }
      }
      return copy;
  }

• example usage

  ...
  
  
  
  
  var common = require('./common');
  
  function validateOptions (userOptions) {
  var options = common.copyOptions(userOptions);
  common.ensureFlagExists('ignoreDeclaration', options);
  common.ensureFlagExists('ignoreAttributes', options);
  common.ensureFlagExists('ignoreText', options);
  common.ensureFlagExists('ignoreComment', options);
  common.ensureFlagExists('ignoreCdata', options);
  common.ensureFlagExists('compact', options);
  common.ensureFlagExists('fullTagEmptyElement', options);
  ...

function xml-js.common.ensureFlagExists (item, options)

• description and source-code

  ensureFlagExists = function (item, options) {
      if (!(item in options) || typeof options[item] !== 'boolean') {
          options[item] = false;
      }
  }

• example usage

  ...
  
  
  
  var common = require('./common');
  
  function validateOptions (userOptions) {
  var options = common.copyOptions(userOptions);
  common.ensureFlagExists('ignoreDeclaration', options);
  common.ensureFlagExists('ignoreAttributes', options);
  common.ensureFlagExists('ignoreText', options);
  common.ensureFlagExists('ignoreComment', options);
  common.ensureFlagExists('ignoreCdata', options);
  common.ensureFlagExists('compact', options);
  common.ensureFlagExists('fullTagEmptyElement', options);
  common.ensureSpacesExists(options);
  ...

function xml-js.common.ensureKeyExists (key, options)

• description and source-code

  ensureKeyExists = function (key, options) {
      if (!(key + 'Key' in options) || typeof options[key + 'Key'] !== 'string') {
          options[key + 'Key'] = options.compact ? '_' + key : key;
      }
  }

• example usage

  ...
  common.ensureFlagExists('ignoreCdata', options);
  common.ensureFlagExists('compact', options);
  common.ensureFlagExists('fullTagEmptyElement', options);
  common.ensureSpacesExists(options);
  if (typeof options.spaces === 'number') {
      options.spaces = Array(options.spaces + 1).join(' ');
  }
  common.ensureKeyExists('declaration', options);
  common.ensureKeyExists('attributes', options);
  common.ensureKeyExists('text', options);
  common.ensureKeyExists('comment', options);
  common.ensureKeyExists('cdata', options);
  common.ensureKeyExists('type', options);
  common.ensureKeyExists('name', options);
  common.ensureKeyExists('elements', options);
  ...

function xml-js.common.ensureSpacesExists (options)

• description and source-code

  ensureSpacesExists = function (options) {
      if (!('spaces' in options) || (typeof options.spaces !== 'number' && typeof options.spaces !== 'string')) {
          options.spaces = 0;
      }
  }

• example usage

  ...
  common.ensureFlagExists('ignoreDeclaration', options);
  common.ensureFlagExists('ignoreAttributes', options);
  common.ensureFlagExists('ignoreText', options);
  common.ensureFlagExists('ignoreComment', options);
  common.ensureFlagExists('ignoreCdata', options);
  common.ensureFlagExists('compact', options);
  common.ensureFlagExists('fullTagEmptyElement', options);
  common.ensureSpacesExists(options);
  if (typeof options.spaces === 'number') {
      options.spaces = Array(options.spaces + 1).join(' ');
  }
  common.ensureKeyExists('declaration', options);
  common.ensureKeyExists('attributes', options);
  common.ensureKeyExists('text', options);
  common.ensureKeyExists('comment', options);
  ...

function xml-js.common.getCommandLineHelp (command, requiredArgs, optionalArgs)

• description and source-code

  getCommandLineHelp = function (command, requiredArgs, optionalArgs) {
      var reqArgs = requiredArgs.reduce(function (res, arg) {return res + ' <' + arg.arg + '>';}, '');
      var output = 'Usage: ' + command + reqArgs + ' [options]' + '\n';
      requiredArgs.forEach(function (argument) {
          output += '  <' + argument.arg + '>' + Array(20 - argument.arg.length).join(' ') + argument.desc + '\n';
      });
      output += '\nOptions:' + '\n';
      optionalArgs.forEach(function (argument) {
          output += '  --' + argument.arg + Array(20 - argument.arg.length).join(' ') + argument.desc + '\n';
      });
      return output;
  }

• example usage

  ...
  options = common.mapCommandLineArgs(requiredArgs, optionalArgs);
  
  
  if (options.version) {
  	console.log(package.version);
  	process.exit(0);
  } else if (options.help || process.argv.length <= 2 + requiredArgs.length - 1) {
  console.log(common.getCommandLineHelp('xml-js', requiredArgs, optionalArgs));
  process.exit(process.argv.length <= 2 ? 1 : 0);
  } else if ('src' in options) {
  //console.log('---------------' + fs.statSync(options.src).isFile());
  if (fs.statSync(options.src).isFile()) {
      if (options.src.split('.').pop() === 'xml') {
          output = xml2json(fs.readFileSync(options.src, 'utf8'), options);
      } else if (options.src.split('.').pop() === 'json') {
  ...

function xml-js.common.mapCommandLineArgs (requiredArgs, optionalArgs)

• description and source-code

  mapCommandLineArgs = function (requiredArgs, optionalArgs) {
      var options = {}, r, o, a = 2;
      for (r = 0; r < requiredArgs.length; r += 1) {
          if (a < process.argv.length && process.argv[a].substr(0, 1) !== '-' && process.argv[a] !== 'JASMINE_CONFIG_PATH=./jasmine
  .json') {
              options[requiredArgs[r].option] = process.argv[a++];
          } else {
              break;
          }
      }
      for (; a < process.argv.length; a += 1) {
          for (o = 0; o < optionalArgs.length; o += 1) {
              if (optionalArgs[o].alias === process.argv[a].slice(1) || optionalArgs[o].arg === process.argv[a].slice(2)) {
                  break;
              }
          }
          if (o < optionalArgs.length) {
              switch (optionalArgs[o].type) {
                  case 'file': case 'string': case 'number':
                      if (a + 1 < process.argv.length) {
                          a += 1;
                          options[optionalArgs[o].option] = (optionalArgs[o].type === 'number' ? Number(process.argv[a]) : process
  .argv[a]);
                      }
                      break;
                  case 'flag':
                      options[optionalArgs[o].option] = true; break;
              }
          }
      }
      return options;
  }

• example usage

  ...
  	    stream += chunk;
  }
  });
  process.stdin.on('end', function () {
  	process.stdout.write(xml2json(stream, {}) + '\n');
  });
  
  options = common.mapCommandLineArgs(requiredArgs, optionalArgs);
  
  
  if (options.version) {
  	console.log(package.version);
  	process.exit(0);
  } else if (options.help || process.argv.length <= 2 + requiredArgs.length - 1) {
  console.log(common.getCommandLineHelp('xml-js', requiredArgs, optionalArgs));
  ...

function xml-js.common.sanitize (text)

• description and source-code

  sanitize = function (text) {
      return text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
  }

• example usage

  ...
  if (options.trim) {
      text = text.trim();
  }
  if (options.nativeType) {
      text = nativeType(text);
  }
  if (options.sanitize) {
      text = common.sanitize(text);
  }
  addField('text', text, options);
  }
  
  function onComment (comment) {
  if (options.ignoreComment) {
      return;
  ...

module xml-js.index

function xml-js.index.js2xml (js, options)

• description and source-code

  js2xml = function (js, options) {
      'use strict';
      options = validateOptions(options);
      var xml = '';
      if (options.compact) {
          xml = writeElementsCompact(js, options, 0, true);
      } else {
          if (js[options.declarationKey]) {
              xml += writeDeclaration(js[options.declarationKey], options);
          }
          if (js[options.elementsKey] && js[options.elementsKey].length) {
              xml += writeElements(js[options.elementsKey], options, 0, !xml);
          }
      }
      return xml;
  }

• example usage

  n/a

function xml-js.index.json2xml (json, options)

• description and source-code

  json2xml = function (json, options) {
      'use strict';
      if (json instanceof Buffer) {
          json = json.toString();
      }
      var js = null;
      if (typeof (json) === 'string') {
          try {
              js = JSON.parse(json);
          } catch (e) {
              throw new Error("The JSON structure is invalid");
          }
      } else {
          js = json;
      }
      return js2xml(js, options);
  }

• example usage

  ...
  
  To convert JavaScript object to XML text, use `js2xml()`. To convert JSON text to XML text, use `json2xml()`.
  
  ```js
  var convert = require('xml-js');
  var json = require('fs').readFileSync('test.json', 'utf8');
  var options = {ignoreText: true, spaces: 4};
  var result = convert.json2xml(json, options);
  console.log(result);
  ```
  
  ### Options for Converting JS object / JSON → XML
  
  The below options are applicable for both `js2xml()` and `json2xml()` functions.
  ...

function xml-js.index.xml2js (xml, userOptions)

• description and source-code

  xml2js = function (xml, userOptions) {
  
      var parser = pureJsParser ? sax.parser(true, {}) : parser = new expat.Parser('UTF-8');
      var result = {};
      currentElement = result;
  
      options = validateOptions(userOptions);
  
      if (pureJsParser) {
          parser.onopentag = onStartElement;
          parser.ontext = onText;
          parser.oncomment = onComment;
          parser.onclosetag = onEndElement;
          parser.onerror = onError;
          parser.oncdata = onCdata;
          parser.onprocessinginstruction = onDeclaration;
      } else {
          parser.on('startElement', onStartElement);
          parser.on('text', onText);
          parser.on('comment', onComment);
          parser.on('endElement', onEndElement);
          parser.on('error', onError);
          //parser.on('startCdata', onStartCdata);
          //parser.on('endCdata', onEndCdata);
          //parser.on('entityDecl', onEntityDecl);
      }
  
      if (pureJsParser) {
          parser.write(xml).close();
      } else {
          if (!parser.parse(xml)) {
              throw new Error('XML parsing error: ' + parser.getError());
          }
      }
  
      if (result[options.elementsKey]) {
          var temp = result[options.elementsKey];
          delete result[options.elementsKey];
          result[options.elementsKey] = temp;
          delete result.text;
      }
  
      return result;
  
  }

• example usage

  ...
  
  To convert XML text to JavaScript object, use `xml2js()`. To convert XML text to JSON text, use `xml2json()`.
  
  ```js
  var convert = require('xml-js');
  var xml = require('fs').readFileSync('test.xml', 'utf8');
  var options = {ignoreText: true, alwaysChildren: true};
  var result = convert.xml2js(xml, options); // or convert.xml2json(xml, options)
  console.log(result);
  ```
  
  ### Options for Converting XML → JS object / JSON
  
  The below options are applicable for both `xml2js()` and `xml2json()` functions.
  ...

function xml-js.index.xml2json (xml, userOptions)

• description and source-code

  xml2json = function (xml, userOptions) {
      'use strict';
      var options, js, json, parentKey;
      options = validateOptions(userOptions);
      js = xml2js(xml, options);
      parentKey = 'compact' in options && options.compact ? '_parent' : 'parent';
      if ('addParent' in options && options.addParent) {
          json = JSON.stringify(js, function (k, v) { return k === parentKey? '_' : v; }, options.spaces);
      } else {
          json = JSON.stringify(js, null, options.spaces);
      }
      return json.replace(/\u2028/g, '\\u2028').replace(/\u2029/g, '\\u2029');
  }

• example usage

  ...
  var xml =
  '<?xml version="1.0" encoding="utf-8"?>' +
  '<note importance="high" logged="true">' +
  '    <title>Happy</title>' +
  '    <todo>Work</todo>' +
  '    <todo>Play</todo>' +
  '</note>';
  var result1 = convert.xml2json(xml, {compact: true, spaces: 4});
  var result2 = convert.xml2json(xml, {compact: false, spaces: 4});
  console.log(result1, '\n', result2);
  ```
  
  To see the result of this code, see the output above in *Synopsis* section.
  
  Or [run and edit](https://runkit.com/587874e079a2f60013c1f5ac/587874e079a2f60013c1f5ad) this code live in the browser.
  ...