xml-twig 1.9.3 → 1.10.0

package/README.md

@@ -20,7 +20,7 @@ When you need to read an XML file, there are two primary approaches:
 This module aims to combine both approaches. It reads the XML document in chunks, and within each chunk, you can utilize the familiar features and functions of a DOM-based parser.
 
 ## Dependencies
-XML documents are parsed using either the [sax](https://www.npmjs.com/package/sax) or [node-expat](https://www.npmjs.com/package/node-expat) parser. parsers. Additional parsers may be added in future releases. By default, the `sax` parser is used. However, I strongly recommend using the `node-expat` parser, as other parsers I tested are not fully compliant with XML standards.
+XML documents are parsed using either the [sax](https://www.npmjs.com/package/sax) or [node-expat](https://www.npmjs.com/package/node-expat) parser. parsers. Additional parsers may be added in future releases. By default, the `sax` parser is used. However, I recommend using the `node-expat` parser, which is faster more compliant with XML standards.
 
 **NOTE: The `node-expat` module is not automatically installed with this module. If you wish to use it, you must install it manually.**
 
@@ -57,6 +57,10 @@ API Documentation: see [Twig](./doc/twig.md)
    const parser = twig.createParser({ tag: twig.Root, function: rootHandler }, { method: 'sax' })
    fs.createReadStream(`${__dirname}/bookstore.xml`).pipe(parser)
 
+   parser.on('error', function (err) {
+      console.error(err);
+   });
+
    // Output -> <bookstore> finished after 48 lines
    ```
 
@@ -386,12 +390,5 @@ This `xml-twig` module focus on reading a XML files. In principle it would be po
 
 Accessing Twig-Elements by [XML-Path](https://www.w3.org/TR/xpath/) language is not supported. One reason it, the `Twig` class models more an [Element](https://www.w3schools.com/xml/xml_elements.asp) rather than a [Node](https://www.w3schools.com/xml/dom_nodes.asp) which would be more generic.
 
-As already mentioned above, I recommend the `expat` parser. The other parser may work for your purpose, however they have several limitations and bugs:
-
-- `sax` does not support UTF-16 encoding. I did not test other encodings, because [W3C Recommendations](https://www.w3.org/TR/xml/#charencoding) defines only UTF-8 and UTF-16 as required
-- `sax` misinterpret character entities
-
-
-
 
 

package/doc/twig.md

@@ -1528,7 +1528,7 @@ Generic error for unsupported condition
 
 ## SAX
 **Kind**: global constant  
-**Version:**: 1.9.3  
+**Version:**: 1.10.0  
 **Author:**: Wernfried Domscheit  
 **Copyright:**: Copyright (c) 2025 Wernfried Domscheit. All rights reserved.  
 **Website:**: https://www.npmjs.com/package/xml-twig  
@@ -1600,7 +1600,7 @@ Optional settings for the Twig parser
 | method | <code>&#x27;sax&#x27;</code> \| <code>&#x27;expat&#x27;</code> | The underlying parser. Either `'sax'`, `'expat'`. |
 | xmlns | <code>boolean</code> | If `true`, then namespaces are accessible by `namespace` property. |
 | trim | <code>boolean</code> | If `true`, then turn any whitespace into a single space. Text and comments are trimmed. |
-| resumeAfterError | <code>boolean</code> | If `true` then parser continues reading after an error. Otherwise it throws exception. |
+| resumeAfterError | <code>boolean</code> | If `true` then parser continues reading after an error.<br> Only relevant for `sax`, `expat` always terminates on error. |
 | partial | <code>boolean</code> | If `true` then unhandled elements are purged. |
 | file | <code>string</code> | Optional. The name of file to be parsed. Just used for information and logging purpose. |
 

package/package.json

@@ -5,7 +5,7 @@
   },
   "name": "xml-twig",
   "description": "Node module for processing huge XML documents in tree mode",
-  "version": "1.9.3",
+  "version": "1.10.0",
   "main": "twig.js",
   "directories": {
     "doc": "doc"

package/twig.js

@@ -1,5 +1,5 @@
 /**
-* @version: 1.9.3
+* @version: 1.10.0
 * @author: Wernfried Domscheit
 * @copyright: Copyright (c) 2025 Wernfried Domscheit. All rights reserved.
 * @website: https://www.npmjs.com/package/xml-twig
@@ -65,7 +65,8 @@ const Any = new AnyHandler();
 * @property {'sax' | 'expat'} method - The underlying parser. Either `'sax'`, `'expat'`.
 * @property {boolean} xmlns - If `true`, then namespaces are accessible by `namespace` property.
 * @property {boolean} trim - If `true`, then turn any whitespace into a single space. Text and comments are trimmed.
-* @property {boolean} resumeAfterError - If `true` then parser continues reading after an error. Otherwise it throws exception.
+* @property {boolean} resumeAfterError - If `true` then parser continues reading after an error.<br>
+* Only relevant for `sax`, `expat` always terminates on error.
 * @property {boolean} partial - If `true` then unhandled elements are purged.
 * @property {string} [file - Optional. The name of file to be parsed. Just used for information and logging purpose.
 * @example { method: 'expat', xmlns: true }
@@ -222,6 +223,15 @@ function createParser(handler, options = {}) {
          parser.emit("close");
       });
 
+      parser.on('error', function (err) {
+         if (options.resumeAfterError) {
+            parser._parser.error = null;
+            parser._parser.resume();
+         } else {
+            parser._parser.close();
+         }
+      });
+
    } else if (EXPAT.includes(options.method)) {
       parser = require("node-expat").createParser();
       Object.defineProperty(parser, 'currentLine', {
@@ -262,6 +272,13 @@ function createParser(handler, options = {}) {
          parser.emit("finish");
       });
 
+      parser.on('error', function (err) {
+         // convert 'err' string into Error object
+         if (typeof err === 'string')
+            parser.emit('error', Error(`${err}\nLine: ${parser.currentLine}\nColumn: ${parser.currentColumn}`))
+         // resume not supported
+      });
+
    } else {
       throw new UnsupportedParser(options.method);
    }
@@ -315,14 +332,6 @@ function createParser(handler, options = {}) {
       }
    });
 
-   parser.on('error', function (err) {
-      console.error(`error at line [${parser.currentLine}], column [${parser.currentColumn}]`, err);
-      if (options.resumeAfterError) {
-         parser.underlyingParser.error = null;
-         parser.underlyingParser.resume();
-      }
-   });
-
    return parser;
 }