diff options
author | Florian Dold <florian.dold@gmail.com> | 2016-11-03 01:33:53 +0100 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2016-11-03 01:33:53 +0100 |
commit | d1291f67551c58168af43698a359cb5ddfd266b0 (patch) | |
tree | 55a13ed29fe1915e3f42f1b1b7038dafa2e975a7 /node_modules/xmlbuilder/README.md | |
parent | d0a0695fb5d34996850723f7d4b1b59c3df909c2 (diff) |
node_modules
Diffstat (limited to 'node_modules/xmlbuilder/README.md')
-rw-r--r-- | node_modules/xmlbuilder/README.md | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/node_modules/xmlbuilder/README.md b/node_modules/xmlbuilder/README.md new file mode 100644 index 000000000..d465aa4ce --- /dev/null +++ b/node_modules/xmlbuilder/README.md @@ -0,0 +1,85 @@ +# xmlbuilder-js + +An XML builder for [node.js](https://nodejs.org/) similar to +[java-xmlbuilder](https://github.com/jmurty/java-xmlbuilder). + +[](http://opensource.org/licenses/MIT) +[](https://npmjs.com/package/xmlbuilder) +[](https://npmjs.com/package/xmlbuilder) + +[](http://travis-ci.org/oozcitak/xmlbuilder-js) +[](https://david-dm.org/oozcitak/xmlbuilder-js) +[](https://coveralls.io/github/oozcitak/xmlbuilder-js) + +### 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 +<?xml version="1.0"?> +<root> + <xmlbuilder> + <repo type="git">git://github.com/oozcitak/xmlbuilder-js.git</repo> + </xmlbuilder> +</root> +``` + +It is also possible to convert objects into nodes: + +``` js +builder.create({ + root: { + xmlbuilder: { + repo: { + '@type': 'git', // attributes start with @ + '#text': 'git://github.com/oozcitak/xmlbuilder-js.git' // text node + } + } + } +}); +``` + +If you need to do some processing: + +``` js +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); +} +``` + +This will result in: + +``` xml +<?xml version="1.0"?> +<squares> + <!-- f(x) = x^2 --> + <data x="1" y="1"/> + <data x="2" y="4"/> + <data x="3" y="9"/> + <data x="4" y="16"/> + <data x="5" y="25"/> +</squares> +``` + +See the [wiki](https://github.com/oozcitak/xmlbuilder-js/wiki) for details. |