1.0.1 • Published 2 years ago

xml-converter v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

xml-converter

A module for converting between XML format and JavaScript objects.

Documentation in Russian

Requirements

  • Node.js version >=16.

Installation

npm i xml-converter

Examples of using

Parsing XML to JavaScript object.

const { parseXML } = require( 'xml-converter' );

const xml = `<root>
<child>
    <tag>string value</tag>
    <tag>78</tag>
</child>
</root>`;

const object = parseXML( xml );

Parsing JavaScript object to XML.

const { parseObject } = require( 'xml-converter' );

const object = {
    root: [
      {
        value: '',
        attrs: {},
        self: false,
        child: [
          {
            value: '',
            attrs: {},
            self: false,
            tag: [
              {
                value: 'string value',
                attrs: {},
                self: false,
              },
              {
                value: '78',
                attrs: {},
                self: false,
              }
            ]
          }
        ]
      }
    ],
  }

const xml = parseObject( object, 2 );

Arguments

parseXML( xml )

ArgumentTypeDescription
xmlstringValid xml string.

parseObject( object, indentSize )

ArgumentTypeDescription
objectobjectValid object described in the next section.
indentSizenumberIndent size for xml string.

Fields and type of the object returned from the parseXML().

FieldTypeDescription
valuestringValue of the XML tag.
attrsobjectObject with tag's attributes { attributeName: 'attributeValue' }.
selfbooleanFlag indicating whether the tag is self-closing.
[tag]arrayArray with child-tags with same tag name.