Skip to content

Latest commit

 

History

History
75 lines (56 loc) · 1.51 KB

README.md

File metadata and controls

75 lines (56 loc) · 1.51 KB

Parser XML 2 JSON

Blazing fast XML parser to JSON written in Rust (node2object).

Requirements

Usage

const parser = require('parser-xml2json')

const xml = `
  <population>
    <entry>
      <name>Alex</name>
      <height>173.5</height>
    </entry>
    <entry>
      <name>Mel</name>
      <height>180.4</height>
    </entry>
  </population>
`

parser.parseString(xml, (err, res) => {
   ...
})

parser.parseFile('/a/xml/file/somewhere.xml', { object: true }, (err, res) => {
  ...
})

API

parseString(xmlString[, options], callback)

  • xmlString - A string that represents an XML
  • options - an optional object where:
    • object - Parse JSON string to Object. default false
  • callback - a function with the signature function (err, result)

parseFile(filePath[, options], callback)

  • filePath - Relative or absolute path to an .xml file
  • options - an optional object where:
    • object - Parse JSON string to Object. default false
  • callback - a function with the signature function (err, result)

Benchmark

Results from a i7 2.2 Ghz

Package                 Time taken
----------------------  ----------
parser-xml2json (rust)  0.0468 s
xml2js (js)             0.1286 s
xml2json (js and c++)   0.1329 s

How to run the benchmark script on your machine

npm i
npm i benchmark/
node benchmark/index.js

License

MIT