fast-xml-parser

Validate XML, Parse XML to JS/JSON and vice versa, or parse XML to Nimn rapidly without C/C++ based libraries and no callback

> This project welcomes contributors. If you have a feature you'd like to see implemented or a bug you'd liked fixed, the best and fastest way to make that happen is to implement it and submit a PR. Basic knowledge of JS is sufficient. Feel free to ask for any guidance.

> If you want to join this project as collaborator / maintainer please let me know, the only condition is to be polite with the users.

Main Features

• Validate XML data syntactically
• Transform XML to JSON or Nimn
• Transform JSON back to XML
• Works with node packages, in browser, and in CLI (press try me button above for demo)
• Faster than any pure JS implementation.
• It can handle big files (tested up to 100mb).
• Various options are available to customize the transformation
  • You can parse CDATA as separate property.
  • You can prefix attributes or group them to separate property. Or can ignore them from result completely.
  • You can parse tag's or attribute's value to primitive type: string, integer, float, hexadecimal, or boolean. And can optionally decode for HTML char.
  • You can remove namespace from tag or attribute name while parsing
  • It supports boolean attributes, if configured.

How to use

To use it in NPM package install it first

$npm install fast-xml-parser or using yarn $yarn add fast-xml-parser

To use it from CLI Install it globally with -g option.

$npm install fast-xml-parser -g

To use it on a webpage include it from a CDN

XML to JSON

var jsonObj = parser.parse(xmlData [,options] );

var parser = require('fast-xml-parser');
var he = require('he');

var options = {
    attributeNamePrefix : "@_",
    attrNodeName: "attr", //default is 'false'
    textNodeName : "#text",
    ignoreAttributes : true,
    ignoreNameSpace : false,
    allowBooleanAttributes : false,
    parseNodeValue : true,
    parseAttributeValue : false,
    trimValues: true,
    cdataTagName: "__cdata", //default is 'false'
    cdataPositionChar: "\\c",
    localeRange: "", //To support non english character in tag/attribute values.
    parseTrueNumberOnly: false,
    attrValueProcessor: a => he.decode(a, {isAttributeValue: true}),//default is a=>a
    tagValueProcessor : a => he.decode(a) //default is a=>a
};

if( parser.validate(xmlData) === true) { //optional (it'll return an object in case it's not valid)
    var jsonObj = parser.parse(xmlData,options);
}

// Intermediate obj
var tObj = parser.getTraversalObj(xmlData,options);
var jsonObj = parser.convertToJson(tObj,options);

Note: he library is used in this example

XML to Nimn

var nimnData = parser.parse(xmlData, schema [,options] );


//Intermediate obj
var tObj = parser.getTraversalObj(xmlData,options);
var jsonObj = parser.convertToJson(tObj,options);

//construct schema manually or with the help of schema builder
var nimndata = parser.convertTonimn(tObj,schema,options);

• NIMN (निम्न) reduces size of the data by 80%.
• Check nimnjs to know more about schema, json to nimndata and reverse transformation.

$xml2js [-ns|-a|-c|-v|-V]  [-o outputfile.json]
$cat xmlfile.xml | xml2js [-ns|-a|-c|-v|-V] [-o outputfile.json]

var result = parser.validate(xmlData);
if (result !== true) console.log(result.err);
var jsonObj = parser.parse(xmlData);

JSON / JS Object to XML

var Parser = require("fast-xml-parser").j2xParser;
//default options need not to set
var defaultOptions = {
    attributeNamePrefix : "@_",
    attrNodeName: "@", //default is false
    textNodeName : "#text",
    ignoreAttributes : true,
    cdataTagName: "__cdata", //default is false
    cdataPositionChar: "\\c",
    format: false,
    indentBy: "  ",
    supressEmptyNode: false,
    tagValueProcessor: a=> he.encode(a, { useNamedReferences: true}),// default is a=>a
    attrValueProcessor: a=> he.encode(a, {isAttributeValue: isAttribute, useNamedReferences: true})// default is a=>a
};
var parser = new Parser(defaultOptions);
var xml = parser.parse(json_or_js_obj);

Benchmark

XML to JSON

JSON to XML

Worth to mention

• निम्न (NIMN) : Save up to 85% network bandwidth and storage space.
• imglab : Speedup and simplify image labeling / annotation process online. Supports multiple formats, one click annotation, easy interface and much more.
• अनुमार्गक (anumargak) : The fastest and simple router for node js web frameworks.
• stubmatic : A stub server to mock behaviour of HTTP(s) / REST / SOAP services. You can also mock binary formats.
• मुनीम (Muneem) : A webframework made for all team members.
• शब्दावली (shabdawali) : Amazing human like typing effects beyond your imagination.

Users

List of applications and projects using Fast XML Parser. (Raise an issue to submit yours)

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]