Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oozcitak/xmlbuilder2
An XML builder for node.js
https://github.com/oozcitak/xmlbuilder2
javascript node-js xml xml-builder xml-parser xml-serializer xmlbuilder
Last synced: 6 days ago
JSON representation
An XML builder for node.js
- Host: GitHub
- URL: https://github.com/oozcitak/xmlbuilder2
- Owner: oozcitak
- Created: 2019-02-14T20:00:12.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T16:17:42.000Z (2 months ago)
- Last Synced: 2024-12-18T11:03:34.318Z (14 days ago)
- Topics: javascript, node-js, xml, xml-builder, xml-parser, xml-serializer, xmlbuilder
- Language: TypeScript
- Homepage:
- Size: 5.48 MB
- Stars: 372
- Watchers: 6
- Forks: 36
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# xmlbuilder2
An XML builder for [node.js](https://nodejs.org/).
[](http://opensource.org/licenses/MIT)
[](https://www.npmjs.com/package/xmlbuilder2)
[](https://www.npmjs.com/package/xmlbuilder2)
[](https://www.jsdelivr.com/package/npm/xmlbuilder2)
[](https://github.com/oozcitak/xmlbuilder2/actions)
[](https://codecov.io/gh/oozcitak/xmlbuilder2)
[](https://david-dm.org/oozcitak/xmlbuilder2)
### Installation:
``` sh
npm install xmlbuilder2
```
### Documentation:
See: https://oozcitak.github.io/xmlbuilder2/
### Usage:
`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
```
### Usage in the browser:
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](https://www.jsdelivr.com/) or [unpkg](https://unpkg.com/):
```html
```
### Donations:
Please consider becoming a backer or sponsor to help support development.
[
](https://opencollective.com/xmlbuilder2)