tXml

a very small and propably the fastest xml parser in pure javascript.

This lib only provides one single method. tXml()

this code is about 230 lines, can be easily extended.
this code is 0.9kb minified + gzipped.
this code is 5 - 10 times faster then sax/xml2js.
this code can running in a worker.
this code is parsing at average the same speed as native DOMParser + potential to be faster.
this code is easy to read and good for study.
this code creates a domObject with minimal footprint, that is easy to traverse.
this code has proven in different projects, like RSS reader, openStreetmap, websites.
this code can even parse handwritten XML that contains various errors.
this code is working in client and server.
this code is 100% covered by unit tests.

so, there are good reasons to give tXml.js a try.

XML - features

tags
childTags
text-nodes
white-spaces
attributes with single and double quotes
attributes without value
xmlComments (ignored)
embedded CSS and Javascript
HTML singleTag elements br, img, link, meta, hr
doctype definitions
xml namespaces
sync API for a sync process
getElementsById/-Class direct on the xmlString
simplify, similar to PHP's SimpleXML
filter, similar to underscore, as a alternative to CSS selectors
monomorphism for fast processing and fewer if statements (a node always has tagName:'', attributes:{} and children:[])
streamSupport ! ! !

Try Online

you can to some test without installing online: tnickel.de

Installation

In browser you load it how ever you want. For example as tag: <script src="tXml.js"></script>.

In node and browseryfy, run "npm install txml" in your project. and then in your script you require it by "var tXml = require('txml');

Methods

tXml (XML-string, options)

XML string is the XML to parse.
options is optional searchId an ID of some object. that can be queried. Using this is incredible fast. filter a method, to filter for interesting nodes, use it like Array.filter. simplify to simplify the object, to an easier access

EXAMPLE 1: tXml("TobiasNickelSoftware DeveloperShanghai / China");

    // will return an object like: 
    [{
        "tagName": "user",
        "attributes": {
            "is": "great"
        },
        "children": [{
                "tagName": "name",
                "children": [ "Tobias" ]
            }, {
                "tagName": "familyName",
                "children": [ "Nickel" ]
            }, {
                "tagName": "profession",
                "children": [ "Software Developer" ]
            }, {
                "tagName": "location",
                "children": [ "Shanghai / China" ]
            }
        ]
    }]

EXAMLPLE 2: tXml("<user is='great'><name>Tobias</name><familyName>Nickel</familyName><profession>Software Developer</profession><location>Shanghai / China</location></user>",{simplify:1});

    // will return an object like: 
    {
        "user": {
            "name": "Tobias",
            "familyName": "Nickel",
            "profession": "Software Developer",
            "location": "Shanghai / China",
            "_attributes": {
                "is": "great"
            }
        }
    }

tXml.simpify (tXml_DOM_Object)

this method is used with the simplify parameter;

tXml_DOM_Object the object to simplify.

tXml.filter (tXml_DOM_Object, f)

this method is used with the filter parameter, it is used like Array.filter.

tXml_DOM_Object the object to filter.
f a function that returns true if you want this elements in the result set.

tXml.getElementById (xml,id)

to find an element by ID. if you are only interested for the information on, a specific node, this is easy and fast, because not the entire xml need to get parsed to a tDOM Object. returns the element not simplified, you can do with tXml.simplify()

xml the xml string to search in.
id the id of the element to find

tXml.getElementsByClassName (xml,className)

find the elements with the given class, without parsing the entire xml into a tDOM. so it is very fast and convenient. returns a list of elements.

xml the xml string to search in.
className the className of the element to find

txml.parseStream (stream, offset)

stream is the stream or fileName,
offset requires you to set short before the first item. usually files begin with simething like "" so the offset need to be before the first item starts so that between that item and the offset is no "<" character. alternatively, pass astring, containing this preample. return stream, triggers even "xml" to get notified when a complete node has been parsed. is usefull for huge files, OSM-world, wikipedia-dump.

Developer

Tobias Nickel German software developer in Shanghai.

bao1018/tXml