xmlbuilder2

An XML builder for node.js.

!GitHub License
!NPM Version
!NPM Downloads
!jsDelivr hits (npm)



$3

`` sh
npm install xmlbuilder2
`

$3

See: https://oozcitak.github.io/xmlbuilder2/




$3

xmlbuilder2 is a wrapper around DOM nodes which adds chainable functions to make it easier to create and work with XML documents. For example the following XML document:

` xml



foobar



`

can be created with the following function chain:

` js
const { create } = require('xmlbuilder2');

const root = create({ version: '1.0' })
.ele('root', { att: 'val' })
.ele('foo')
.ele('bar').txt('foobar').up()
.up()
.ele('baz').up()
.up();

// convert the XML tree to string
const xml = root.end({ prettyPrint: true });
console.log(xml);
`

___

The same XML document can be created by converting a JS object into XML nodes:

` js
const { create } = require('xmlbuilder2');

const obj = {
root: {
'@att': 'val',
foo: {
bar: 'foobar'
},
baz: {}
}
};

const doc = create(obj);
const xml = doc.end({ prettyPrint: true });
console.log(xml);
`
___

xmlbuilder2 can also parse and serialize XML documents from different formats:
`js
const { create } = require('xmlbuilder2');

const xmlStr = 'foobar';
const doc = create(xmlStr);

// append a 'baz' element to the root node of the document
doc.root().ele('baz');

const xml = doc.end({ prettyPrint: true });
console.log(xml);
`
which would output the same document string at the top of this page.

Or you could return a JS object by changing the format argument to 'object':
`js
const obj = doc.end({ format: 'object' });
console.log(obj);
`
`js
{
root: {
'@att': 'val',
foo: {
bar: 'foobar'
},
baz: {}
}
}
`

___

You can convert between formats in one go with the convert function:

`js
const { convert } = require('xmlbuilder2');

const xmlStr = 'foobar';
const obj = convert(xmlStr, { format: "object" });

console.log(obj);
`
`js
{
root: {
'@att': 'val',
foo: {
bar: 'foobar'
}
}
}
`

___

If you need to do some processing:

` js
const { create } = require('xmlbuilder2');

const root = create().ele('squares');
root.com('f(x) = x^2');
for(let i = 1; i <= 5; i++)
{
const item = root.ele('data');
item.att('x', i);
item.att('y', i * i);
}

const xml = root.end({ prettyPrint: true });
console.log(xml);
`

This will result in:

` xml









`

$3

You can build the minified production bundle (lib/xmlbuilder2.min.js) after cloning the repository and issuing npx webpack in your terminal. The bundle is also in the npm package, so you can also use a public npm CDN like jsDelivr or unpkg:

`html




``

$3

Please consider becoming a sponsor to help support development.

:heart: Github Sponsors