XML

Works with XML data. I haven't tested with xlsx or other similar data types yet. There's a lot of things to improve here.

Usage

Both xml.parse() and xml.stringify() accepts the data to be parsed/stringified as the first argument, and an option's object as the second.

Parse

const assert = require('assert')
const { xml } = require('parserblade')
const input = '<?xml version="1.0" encoding="utf-8"?><games><name>Naruto Shippuden Storm 3</name><platform>playstation</platform></games>'
const result = xml.parse(input)

assert.deepStrictEqual(
  result,
  {
    games: {
      name: { _text: 'Naruto Shippuden Storm 3' },
      platform: { _text: 'playstation' }
    }
  }
)

const assert = require('assert')
const { xml } = require('parserblade')
const input = '<?xml version="1.0" encoding="utf-8"?><packages><name>mongoose</name><name>sequelize</name></packages>'
const result = xml.parse(input)

assert.deepStrictEqual(
  result,
  {
    packages: {
      name: [
        { _text: 'mongoose' },
        { _text: 'sequelize' }
      ]
    }
  }
)

Parse XML including declaration

Pass { showDeclaration: true } as option.

const assert = require('assert')
const { xml } = require('parserblade')
const input = '<?xml version="1.0" encoding="utf-8"?><packages><name>mongoose</name><name>sequelize</name></packages>'
const result = xml.parse(input, { showDeclaration: true })

assert.deepStrictEqual(
  result,
  {
    _declaration: {
      _attributes: {
        encoding: 'utf-8',
        version: 1
      }
    },
    packages: {
      name: [
        { _text: 'mongoose' },
        { _text: 'sequelize' }
      ]
    }
  }
)

Parse XML in verbose mode

Pass { verbose: true } as option.

const assert = require('assert')
const { xml } = require('parserblade')
const input = '<?xml version="1.0" encoding="utf-8"?><games><name>Naruto Shippuden Storm 3</name><platform>playstation</platform></games>'
const result = xml.parse(input, { verbose: true })
const expected = {
  elements: [
    {
      type: 'element',
      name: 'games',
      elements: [
        {
          type: 'element',
          name: 'name',
          elements: [
            {
              type: 'text',
              text: 'Naruto Shippuden Storm 3'
            }
          ]
        },
        {
          type: 'element',
          name: 'platform',
          elements: [
            {
              type: 'text',
              text: 'playstation'
            }
          ]
        },
      ]
    }
  ]
}

assert.deepStrictEqual(
  result,
  expected
)

Stringify

const assert = require('assert')
const { xml } = require('parserblade')
const input = { game: 'Stardew Valley' }
const result = xml.stringify(input)

assert.deepStrictEqual(
  result,
  '<?xml version="1.0" encoding="utf-8"?><game>Stardew Valley</game>'
)

Stringify without XML declaration

const assert = require('assert')
const { xml } = require('parserblade')
const input = { game: 'Stardew Valley' }
const result = xml.stringify(input, { ignoreDeclaration: true })

assert.deepStrictEqual(
  result,
  '<game>Stardew Valley</game>'
)

Stringify array

const assert = require('assert')
const { xml } = require('parserblade')
const input = {
  packages: [
    { name: 'lodash' }
  ]
}
const result = xml.stringify(input)

assert.deepStrictEqual(
  result,
  '<?xml version="1.0" encoding="utf-8"?><packages><name>lodash</name></packages>'
)

Stringify with metadata

const assert = require('assert')
const { xml } = require('parserblade')
const input = {
  packages: [
    {
      _text: 'lodash',
      _attributes: { lang: 'nodejs' }
    },
    {
      _text: 'flash',
      _attributes: { lang: 'python' }
    }
  ]
}
const result = xml.stringify(input)

assert.deepStrictEqual(
  result,
  '<?xml version="1.0" encoding="utf-8"?><packages lang="nodejs">lodash</packages><packages lang="python">flash</packages>'
)

Valid

Just checks if given string is a valid XML

const assert = require('assert')
const { xml } = require('parserblade')
const result = xml.valid('phrase<tag />')

assert.equal(
  result,
  false
)

Stream

pipeParse

You may specify in which depth it should emit data, defaults to 0.

const { Readable } = require('stream')
const { xml } = require('parserblade')
const input = `
<?xml version="1.0" encoding="utf-8"?>
<info>
  <name>Naruto Shippuden Storm 3</name>
  <platform>
    platform
    <another>
      This is another tag
    </another>
    <another>
      Third tag another
    </another>
  </platform>
  <site url="netflix">
    Netflix
    <description>
      Possible description here
    </description>
  </site>
</info>
`.split('')

const reader = new Readable({
  read () {
    const next = input.shift()
    if (typeof next === 'string') {
      this.push(next)
    } else {
      this.push(null)
    }
  }
})

reader
  .pipe(xml.pipeParse())
  .on('data', console.log)
  .on('error', console.log)
  .on('end', () => console.log('stream ended'))

pipeStringify

You can set which tag wraps everything with { mainTag: { name, text, attributes } }

const { Readable } = require('stream')
const { xml } = require('parserblade')
const input = [{ name: 'Starcraft II' }]

const reader = new Readable({
  objectMode: true,
  read () {
    const next = input.shift()
    this.push(next || null)
  }
})

reader
  .pipe(xml.pipeParse({ mainTag: { name: 'games' } }))
  .on('data', console.log)
  .on('error', console.log)
  .on('end', () => console.log('stream ended'))