Palak Handa / startUpJalsa-Backend

Blame view

node_modules/xmlbuilder/README.md 2.26 KB
edit raw normal view history
f7563de62   Palak Handa   first commit 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
  # 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)
  
  [![Build Status](http://img.shields.io/travis/oozcitak/xmlbuilder-js.svg?style=flat-square)](http://travis-ci.org/oozcitak/xmlbuilder-js)
  [![Dependency Status](http://img.shields.io/david/oozcitak/xmlbuilder-js.svg?style=flat-square)](https://david-dm.org/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)
  
  ### 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.