XMLWriter for NodeJS


It's native and full javascript implementation of the classic XMLWriter class.
The API is complete, flexible and tolerant.
XML is still valid.

Contributors

* Nicolas Thouvenin
* Anton Zem
* Chip Lee
* Peecky
* Julian Scheid
* Guillaume Plique

Installation

With npm do:

$ npm install xml-writer

Examples

Basic

``javascript
var XMLWriter = require('xml-writer');
xw = new XMLWriter;
xw.startDocument();
xw.startElement('root');
xw.writeAttribute('foo', 'value');
xw.text('Some content');
xw.endDocument();

console.log(xw.toString());
`
Output:


Some content

Tip: If you want your XML indented use new XMLWriter(true) or new XMLWriter('\t'), for instance, if you want to use a custom string for indentation.

Chaining


`javascript
var XMLWriter = require('xml-writer');
xw = new XMLWriter;
xw.startDocument().startElement('root').writeAttribute('foo', 'value').writeElement('tag', 'Some content');

console.log(xw.toString());
`
Output:


Some content

Tolerant


`javascript
var XMLWriter = require('xml-writer');
xw = new XMLWriter;
xw.startElement('root').writeAttribute('foo', 'value').text('Some content');

console.log(xw.toString());
`
Output:

Some content




Extensible


`javascript
var XMLWriter = require('xml-writer'),
fs = require('fs');
var ws = fs.createWriteStream('/tmp/foo.xml');
ws.on('close', function() {
console.log(fs.readFileSync('/tmp/foo.xml', 'UTF-8'));
});
xw = new XMLWriter(false, function(string, encoding) {
ws.write(string, encoding);
});
xw.startDocument('1.0', 'UTF-8').startElement(function() {
return 'root';
}).text(function() {
return 'Some content';
});
ws.end();
``

Output:

Some content

Tests

Use nodeunit to run the tests.

$ npm install nodeunit
$ nodeunit test

API Documentation

Generic

$3

Create an new writer

$3

Write text

$3

Write a raw XML text

Document

$3

Create document tag

$3

End current document

Element

$3

Write full element tag

$3

Write full namespaced element tag

$3

Create start namespaced element tag

$3

Create start element tag

$3

End current element

Attributes

$3

Write full attribute

$3

Write full namespaced attribute

$3

Create start namespaced attribute

$3

Create start attribute

$3

End attribute

Processing Instruction

$3

Writes a PI

$3

Create start PI tag

$3

End current PI

DocType

$3

Write a DocType

$3

Create start DocType tag

$3

End current DocType

CData

$3

Write full CDATA tag

$3

Create start CDATA tag

$3

End current CDATA

Comment

$3

Write full comment tag

$3

Create start comment

$3

Create end comment

Also

* https://github.com/minchenkov/simple-xml-writer
* https://github.com/wezm/node-genx

License

MIT/X11