README

toXML - Pure JavaScript XML Writer

Live Demo: https://kawanet.github.io/from-xml/

FEATURES

Simple: single writer function toXML() which returns XML string.
Small: 2KB minified, 1KB gzipped.
Standalone: no external module dependency nor DOM needed.
TypeScript definition: to-xml.d.ts

SYNOPSIS

Node.js:

const toXML = require("to-xml").toXML;

Browser:

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

Run:

const data = {
  "xml": {
    "@foo": "FOO",
    "bar": {
      "baz": "BAZ"
    }
  }
};

const xml = toXML(data, null, 2);

console.warn(xml);

Result:

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

EXAMPLES

Empty Element

JavaScript: null

{
  "xml": {
    "foo": {"@bar": "BAR"},
    "buz": null,
    "qux": {},
    "quux": ""
  }
}

XML: empty element

<xml>
  <foo bar="BAR"/>
  <buz/>
  <qux></qux>
  <quux></quux>
</xml>

Empty Attribute

JavaScript: @ property name or null value

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

XML: empty attribute

<xml bar baz>
    <foo>FOO</foo>
</xml>

Multiple Child Nodes

JavaScript: Array of String or Array of Object

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

XML: child nodes

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

Text Node with Attribute

JavaScript: # property name

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

XML: text node

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

XML Declaration and Comment

JavaScript: ? and ! property name

{
  "?": "xml version=\"1.0\"",
  "!": "DOCTYPE note SYSTEM \"Note.dtd\"",
  "note": {
    "title": "FOO",
    "!": "-- comment --",
    "body": "BAR"
  }
}

XML:

<?xml version="1.0"?>
<!DOCTYPE note SYSTEM "Note.dtd">
<note>
  <title>FOO</title>
  <!-- comment -->
  <body>BAR</body>
</note>

Fragment

JavaScript: # property name

{
  "plist": {
    "@version": "1.0",
    "dict": {
      "#": [
        {"key": "CFBundleDevelopmentRegion"},
        {"string": "ja"},
        {"key": "CFBundleIcons"},
        {"dict": null},
        {"key": "LSRequiresIPhoneOS"},
        {"true": null}
      ]
    }
  }
}

XML: child node list in order

<plist version="1.0">
  <dict>
    <key>CFBundleDevelopmentRegion</key>
    <string>ja</string>
    <key>CFBundleIcons</key>
    <dict/>
    <key>LSRequiresIPhoneOS</key>
    <true/>
  </dict>
</plist>

CLI

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

LICENSE

The MIT License (MIT)

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.

to-xml

Usage no npm install needed!