What is fast-xml-parser?
The fast-xml-parser npm package is a fast and powerful XML parser and validator that can convert XML to a JavaScript object, JSON, or a traversable JS object. It can also convert a JS object to XML. It is designed to be very fast and efficient, and it provides various options to control the XML parsing and validation process.
What are fast-xml-parser's main functionalities?
XML to JSON Conversion
Converts XML data to a JSON object. The 'parse' function takes an XML string and optional options object, and returns a JSON representation of the XML.
const { parse } = require('fast-xml-parser');
const xmlData = '<note><to>User</to><from>Library</from><heading>Reminder</heading><body>Don't forget to subscribe.</body></note>';
const options = {};
const jsonObj = parse(xmlData, options);
JSON to XML Conversion
Converts a JSON object to an XML string. The 'j2xParser' constructor takes an options object, and the 'parse' method converts the JSON object to an XML string.
const { j2xParser } = require('fast-xml-parser');
const parser = new j2xParser({});
const jsonObj = { note: { to: 'User', from: 'Library', heading: 'Reminder', body: 'Don't forget to subscribe.' } };
const xmlData = parser.parse(jsonObj);
XML Validation
Validates the XML string. The 'validate' function checks if the given XML string is well-formed and returns a validation result.
const { validate } = require('fast-xml-parser');
const xmlData = '<note><to>User</to><from>Library</from></note>';
const validationResult = validate(xmlData);
Traversable Object Creation
Creates a traversable JavaScript object from XML. The 'XMLParser' constructor creates a parser instance, and the 'parse' method converts the XML string into a traversable JS object.
const { XMLParser } = require('fast-xml-parser');
const xmlData = '<note><to>User</to><from>Library</from></note>';
const parser = new XMLParser();
const traversableObject = parser.parse(xmlData);
Other packages similar to fast-xml-parser
xml2js
xml2js is a similar npm package that provides XML to JavaScript object conversion. It includes options to customize the parsing process and supports builder options for converting back to XML. Compared to fast-xml-parser, xml2js may be slower but offers a more feature-rich API for handling complex XML structures.
xml-js
xml-js is another npm package that converts XML text to a JavaScript object and vice versa. It can also convert XML to JSON and supports compact and non-compact modes. While fast-xml-parser focuses on speed, xml-js provides a more extensive set of conversion options.
libxmljs
libxmljs is a Node.js package that provides bindings to the libxml C library. It allows for parsing and serializing XML and includes XPath and XSLT support. It is different from fast-xml-parser in that it is a binding to a native library, which may offer performance benefits and additional XML processing features.
Validate XML, Parse XML to JS Object, or Build XML from JS Object without C/C++ based libraries and no callback.
Looking for maintainers
Support this project by becoming a Sponsor.
Click on Sponsor button above or
Check ThankYouBackers for our supporters
Users
Check the list of all known users here;
The list of users is collected either from the list published by Github, cummunicated directly through mails/chat , or from other resources. If you feel that your name in the above list is incorrectly published or you're not the user of this library anymore then you can inform us to remove it. We'll do the necessary changes ASAP.
Main Features
- Validate XML data syntactically
- Parse XML to JS Object
- Build XML from JS Object
- Works with node packages, in browser, and in CLI (press try me button above for demo)
- Faster than any other pure JS implementation.
- It can handle big files (tested up to 100mb).
- Controlled parsing using various options
- XML Entities, HTML entities, and DOCTYPE entites are supported.
- unpaired tags (Eg
<br>
in HTML), stop nodes (Eg <script>
in HTML) are supported. - You can restore almost same XML from JSON
- Supports comments
- It can preserve Order of tags in JS object
- You can control if a single tag should be parsed into array.
- Supports parsing of PI (Processing Instruction) tags with XML declaration tags
- And many more other features.
How to use
To use as package dependency
$ npm install fast-xml-parser
or
$ yarn add fast-xml-parser
To use as system command
$ npm install fast-xml-parser -g
To use it on a webpage include it from a CDN
Example
As CLI command
$ fxparser some.xml
In a node js project
const { XMLParser, XMLBuilder, XMLValidator} = require("fast-xml-parser");
const parser = new XMLParser();
let jObj = parser.parse(XMLdata);
const builder = new XMLBuilder();
const xmlContent = builder.build(jObj);
In a HTML page
<script src="path/to/fxp.min.js"></script>
:
<script>
const parser = new fxparser.XMLParser();
parser.parse(xmlContent);
</script>
Check lib folder for different browser bundles
Bundle Name | Size |
---|
fxbuilder.min.js | 5.2K |
fxparser.js | 50K |
fxparser.min.js | 17K |
fxp.min.js | 22K |
fxvalidator.min.js | 5.7K |
Documents
v3
v4
- GettingStarted.md
- XML Parser
- XML Builder
- XML Validator
- Entities
- HTML Document Parsing
- PI Tag processing
Performance
XML Parser
- Y-axis: requests per second
- X-axis: File size
Large files
- Y-axis: requests per second
- X-axis: File size
XML Builder
- Y-axis: requests per second
negative means error
Our other projects and research you must try
- BigBit standard :
- Single text encoding to replace UTF-8, UTF-16, UTF-32 and more with less memory.
- Single Numeric datatype alternative of integer, float, double, long, decimal and more without precision loss.
- Cytorus: Be specific and flexible while running E2E tests.
- Run tests only for a particular User Story
- Run tests for a route or from a route
- Customizable reporting
- Central dashboard for better monitoring
- Options to integrate E2E tests with Jira, Github etc using Central dashboard
Tian
.
- Stubmatic : Create fake webservices, DynamoDB or S3 servers, Manage fake/mock stub data, Or fake any HTTP(s) call.
Supporters
Contributors
This project exists thanks to all the people who contribute. [Contribute].
Backers
Thank you to all our backers! 🙏 [Become a backer]
License