https://github.com/oozcitak/xmlbuilder-js

An XML builder for node.js
https://github.com/oozcitak/xmlbuilder-js

coffeescript javascript node-js xml xmlbuilder

Last synced: 1 day ago
JSON representation

An XML builder for node.js

• Host: GitHub
• URL: https://github.com/oozcitak/xmlbuilder-js
• Owner: oozcitak
• License: mit
• Created: 2010-11-01T20:01:15.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2024-08-07T17:51:41.000Z (6 months ago)
• Last Synced: 2025-01-14T03:05:54.417Z (8 days ago)
• Topics: coffeescript, javascript, node-js, xml, xmlbuilder
• Language: CoffeeScript
• Homepage:
• Size: 985 KB
• Stars: 918
• Watchers: 17
• Forks: 110
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-nodejs - xmlbuilder - An XML builder for node.js.  (Repository / Parsing)

README

        
# xmlbuilder-js

An XML builder for [node.js](https://nodejs.org/) similar to

[java-xmlbuilder](https://github.com/jmurty/java-xmlbuilder).

[![License](http://img.shields.io/npm/l/xmlbuilder.svg?style=flat-square)](http://opensource.org/licenses/MIT)

[![NPM Version](http://img.shields.io/npm/v/xmlbuilder.svg?style=flat-square)](https://npmjs.com/package/xmlbuilder)

[![NPM Downloads](https://img.shields.io/npm/dm/xmlbuilder.svg?style=flat-square)](https://npmjs.com/package/xmlbuilder)

[![Travis Build Status](http://img.shields.io/travis/com/oozcitak/xmlbuilder-js.svg?style=flat-square)](https://www.travis-ci.com/github/oozcitak/xmlbuilder-js)

[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/bf7odb20hj77isry?svg=true)](https://ci.appveyor.com/project/oozcitak/xmlbuilder-js)

[![Dev Dependency Status](http://img.shields.io/david/dev/oozcitak/xmlbuilder-js.svg?style=flat-square)](https://david-dm.org/oozcitak/xmlbuilder-js)

[![Code Coverage](https://img.shields.io/coveralls/oozcitak/xmlbuilder-js.svg?style=flat-square)](https://coveralls.io/github/oozcitak/xmlbuilder-js)

### Announcing `xmlbuilder2`:

The new release of `xmlbuilder` is available at [`xmlbuilder2`](https://github.com/oozcitak/xmlbuilder2)! `xmlbuilder2` has been redesigned from the ground up to be fully conforming to the [modern DOM specification](https://dom.spec.whatwg.org). It supports XML namespaces, provides built-in converters for multiple formats, collection functions, and more. Please see [upgrading from xmlbuilder](https://oozcitak.github.io/xmlbuilder2/upgrading-from-xmlbuilder.html) in the wiki.

New development will be focused towards `xmlbuilder2`; `xmlbuilder` will only receive critical bug fixes.

### Installation:

``` sh

npm install xmlbuilder

```

### Usage:

``` js

var builder = require('xmlbuilder');

var xml = builder.create('root')

  .ele('xmlbuilder')

    .ele('repo', {'type': 'git'}, 'git://github.com/oozcitak/xmlbuilder-js.git')

  .end({ pretty: true});

console.log(xml);

```

will result in:

``` xml

  

    git://github.com/oozcitak/xmlbuilder-js.git

  

```

It is also possible to convert objects into nodes:

``` js

var builder = require('xmlbuilder');

var obj = {

  root: {

    xmlbuilder: {

      repo: {

        '@type': 'git', // attributes start with @

        '#text': 'git://github.com/oozcitak/xmlbuilder-js.git' // text node

      }

    }

  }

};

var xml = builder.create(obj).end({ pretty: true});

console.log(xml);

```

If you need to do some processing:

``` js

var builder = require('xmlbuilder');

var root = builder.create('squares');

root.com('f(x) = x^2');

for(var i = 1; i <= 5; i++)

{

  var item = root.ele('data');

  item.att('x', i);

  item.att('y', i * i);

}

var xml = root.end({ pretty: true});

console.log(xml);

```

This will result in:

``` xml

  

  

  

  

  

  

```

### Documentation:

See the [wiki](https://github.com/oozcitak/xmlbuilder-js/wiki) for details and [examples](https://github.com/oozcitak/xmlbuilder-js/wiki/Examples) for more complex examples.

### Donations:

Please consider becoming a backer or sponsor to help support development.

[](https://opencollective.com/xmlbuilder)