fast xml parser

Validate XML, Parse XML and Build XML rapidly without C/C++ based libraries and no callback.

2582

308

JavaScript

fast-xml-parser

[![NPM quality][quality-image]][quality-url]

Validate XML, Parse XML to JS Object, or Build XML from JS Object without C/C++ based libraries and no callback.

I had recently published a book, The Power Glasses. Please have a look. Your feedback would be helpful. You can mail me for a free copy.

Sponsor this project

fxp_sponsors
Hiroki Kokubun

Users

The list of users are mostly published by Github or communicated directly. Feel free to contact if you find any information wrong.

Main Features

Validate XML data syntactically
Parse XML to JS Object
Build XML from JS Object
Compatible to node js packages, in browser, and in CLI (click 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.

v5

I developed v5 in Apr 2023. And I didn’t get the chance to complete all the features. I’ve ensured that new features don’t impact performance. With v5, you have more control on parsing output. Check docs for syntax help and basic understanding.

Please leave a comment in discussion forum for your suggestions and if you really need v5.

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>

Bundle size

Bundle Name	Size
fxbuilder.min.js	6.5K
fxparser.min.js	20K
fxp.min.js	26K
fxvalidator.min.js	5.7K

Documents

v3	v4	v5
documents	Getting Started XML Parser XML Builder XML Validator Entities HTML Document Parsing PI Tag processing	Getting Started Features Options Output Builders Value Parsers

note: version 5 is released with version 4 tfor experimental use. Based on it’s demand, it’ll be developed and the features can be different in final release.