from-xml

fromXML - Pure JavaScript XML Parser

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
from-xml
3230.1.72 years ago6 years agoMinified + gzip package size for from-xml in KB

Readme

fromXML - Pure JavaScript XML Parser
Node.js CI npm version
Live Demo: https://kawanet.github.io/from-xml/

FEATURES

  • Simple: single parser function fromXML(xml) which returns JavaScript Object.
  • Small: 2KB minified, 1KB gzipped.
  • Standalone: no external module dependency nor DOM needed.
  • TypeScript definition: from-xml.d.ts

SYNOPSIS

Node.js:
const fromXML = require("from-xml").fromXML;

Browser:
<script src="https://cdn.jsdelivr.net/npm/from-xml/dist/from-xml.min.js"></script>

Run:
const xml = '<xml foo="FOO"><bar><baz>BAZ</baz></bar></xml>';

const data = fromXML(xml);

console.warn(data.xml.bar.baz); // => "BAZ"

console.warn(data.xml["@foo"]); // => "FOO"

EXAMPLES

XML:
<xml foo="FOO">
  <bar>
    <baz>BAZ</baz>
  </bar>
</xml>

JavaScript:
{
  "xml": {
    "@foo": "FOO",
    "bar": {
      "baz": "BAZ"
    }
  }
}

Empty Element

XML:
<xml>
  <foo/>
  <bar></bar>
  <qux quux="QUUX"/>
</xml>

JavaScript:
{
  "xml": {
    "foo": null,
    "bar": "",
    "qux": {
      "@quux": "QUUX"
    }
  }
}

Empty Attribute

XML:
<xml>
  <foo bar="" baz/>
</xml>

JavaScript:
{
  "xml": {
    "foo": {
      "@bar": "",
      "@baz": null
    }
  }
}

Multiple Child Nodes

XML:
<xml>
  <foo>BAR</foo>
  <foo>BAZ</foo>
  <foo>QUX</foo>
</xml>

JavaScript:
{
  "xml": {
    "foo": ["BAR", "BAZ", "QUX"]
  }
}

Text Node with Attribute

XML:
<xml>
  <foo bar="BAR">
    BAZ
  </foo>
</xml>

JavaScript:
{
  "xml": {
    "foo": {
      "@bar": "BAR",
      "#": "BAZ"
    }
  }
}

CLI

$ echo '<foo bar="BAR"><buz>BUZ</buz></foo>' | ./node_modules/.bin/xml2json -2
{
  "foo": {
    "@bar": "BAR",
    "buz": "BUZ"
  }
}

LINKS

  • https://github.com/kawanet/from-xml
  • https://www.npmjs.com/package/from-xml
  • https://www.npmjs.com/package/to-xml
  • https://www.npmjs.com/package/xml-objtree

LICENSE

The MIT License (MIT)
Copyright (c) 2016-2021 Yusuke Kawasaki
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.