ScriptX

Appearance

XMLParser ​

Event-based XML parser

XMLParser provides SAX-style XML parsing with callback functions.

Use XMLParser to:

Note

For JSON data, use JSON.parse() instead

Examples ​

javascript
let xml = "<root><item>Hello</item></root>";
let parser = new XMLParser(xml);

parser.didStartElement = (name, attrs) => {
    console.log("Start:", name);
};

parser.foundCharacters = (text) => {
    console.log("Text:", text);
};

parser.didEndElement = (name) => {
    console.log("End:", name);
};

let success = parser.parse();

Properties ​

didStartDocument ​

  • Type: JSValue

Callback when document parsing starts

javascript
parser.didStartDocument = () => { }

didEndDocument ​

  • Type: JSValue

Callback when document parsing ends

javascript
parser.didEndDocument = () => { }

didStartElement ​

  • Type: JSValue

Callback when an element starts

Called with element name and attributes dictionary.

javascript
parser.didStartElement = (name, attrs) => { }

didEndElement ​

  • Type: JSValue

Callback when an element ends

Called with element name.

javascript
parser.didEndElement = (name) => { }

foundCharacters ​

  • Type: JSValue

Callback for text content

Called with character data found in elements.

javascript
parser.foundCharacters = (text) => { }

parseErrorOccurred ​

  • Type: JSValue

Callback for parse errors

Called with error message when parsing fails.

javascript
parser.parseErrorOccurred = (error) => { }

string ​

  • Type: String

XML string to parse

javascript
parser.string = "<xml>...</xml>"

Methods ​

parse ​

Parse the XML string

Parses the XML and calls registered callbacks.

typescript
parse(): boolean

Returns: true if parsing succeeded, false otherwise

Example:

javascript
let success = parser.parse()