Javascript implementation of the classic XMLWriter class
JavaScript
Permalink
Failed to load latest commit information.
lib #16 May 22, 2015
test Escape according to Canonical XML 1.0. Nov 13, 2014
.gitignore update dotfile for istanbul Sep 16, 2014
.npmignore update dotfile for istanbul Sep 16, 2014
.travis.yml istanbul can not use 0.6 Sep 16, 2014
LICENSE do Nov 21, 2011
README.md add contributor Nov 14, 2014
index.js init files Nov 19, 2011
package.json 1.6.0 Nov 14, 2014

README.md

XMLWriter for NodeJS

Build Status

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

Contributors

Installation

With npm do:

$ npm install xml-writer

Examples

Basic

    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:

<?xml version="1.0"?>
<root foo="value">Some content</root>

Tip: If you want your XML indented use new XMLWriter(true).

Chaining

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

    console.log(xw.toString());

Output:

<?xml version="1.0"?>
<root foo="value"><tag>Some content</tag></root>

Tolerant

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

    console.log(xw.toString());

Output:

<root foo="value">Some content</root>

Extensible

    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:

<?xml version="1.0" encoding="UTF-8"?>
<root>Some content</root>

Tests

Use nodeunit to run the tests.

$ npm install nodeunit
$ nodeunit test

API Documentation

Generic

constructor XMLWriter(Boolean indent, Function writer(string, encoding))

Create an new writer

text(String content)

Write text

writeRaw

Write a raw XML text

Document

startDocument(String version = '1.0', String encoding = NULL, Boolean standalone = false)

Create document tag

endDocument()

End current document

Element

writeElement(String name, String content)

Write full element tag

writeElementNS

Write full namespaced element tag

startElementNS

Create start namespaced element tag

startElement(String name)

Create start element tag

endElement()

End current element

Attributes

writeAttribute(String name, String value)

Write full attribute

writeAttributeNS

Write full namespaced attribute

startAttributeNS

Create start namespaced attribute

startAttribute(String name)

Create start attribute

endAttribute()

End attribute

Processing Instruction

writePI(String name, String content)

Writes a PI

startPI(String name)

Create start PI tag

endPI()

End current PI

DocType

writeDocType(String name, String pubid, String sysid, String subset)

Write a DocType

startDocType(String name, String pubid, String sysid, String subset)

Create start DocType tag

endDocType()

End current DocType

CData

writeCData(String content)

Write full CDATA tag

startCData()

Create start CDATA tag

endCData()

End current CDATA

Comment

writeComment(String content)

Write full comment tag

startComment()

Create start comment

endComment()

Create end comment

Also

License

MIT/X11

Bitdeli Badge