XMLIterator

Description

XMLIterator is a low level synchronous XML parser implemented as an ECMAScript iterator.

It takes a String containing a whole XML document and parses it giving out a sequence of XMLNode instances.

For self enclosed tags, a pair of objects (StartElement / EndElement) is emitted.

Usage

  const xml = fs.readFileSync ('small.xml', 'utf-8')
	
  for (const node of new XMLIterator (xml, {})) 
    if (node.isStartElement && node.localName === 'user') 
      return node.attributes.get ('id')  

Options

Name	Default	Description
entityResolver	EntityResolver	to be used with generated XMLNodes

Comparison to XMLLexer

XMLLexer and XMLIterator and are both low level XML parsers splitting pointy bracket delimited text to syntactically atomic tokens. But:

• XMLLexer takes the source in the form of a Stream and represents a Transform (thus, an asynchronous iterator) designed to process documents of any size with a limited memory footprint;
• XMLIterator requires the source to be completely loaded in memory as a finite string, but provides the regular Iterator that can be used in synchronous environments (e. g. in object constructors).

So, XMLLexer vs. XMLIterator is basically like fs.createReadStream vs. fs.readFileSync.