xml-twig 1.3.0 → 1.3.2

package/doc/twig.md

@@ -143,6 +143,7 @@ You can specify a <code>function</code> or a <code>event</code> name</p>
     * [.pin](#Twig+pin)
     * [.pinned](#Twig+pinned) ⇒ <code>boolean</code>
     * [.close](#Twig+close)
+    * [.debug](#Twig+debug) ⇒ <code>string</code>
     * [.addChild](#Twig+addChild) ℗
     * [.writer](#Twig+writer) ⇒ [<code>XMLWriter</code>](https://www.npmjs.com/package/xml-writer)
     * [.attr](#Twig+attr) ⇒ <code>string</code> \| <code>number</code> \| <code>object</code>
@@ -355,6 +356,13 @@ Checks if element is pinned
 Closes the element
 
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
+<a name="Twig+debug"></a>
+
+### twig.debug ⇒ <code>string</code>
+XML-Twig for dummies :-)
+
+**Kind**: instance property of [<code>Twig</code>](#Twig)  
+**Returns**: <code>string</code> - The XML-Tree which is currently available in RAM - no valid XML Structure  
 <a name="Twig+addChild"></a>
 
 ### twig.addChild ℗
@@ -752,6 +760,7 @@ Common function to filter Twig element
     * [.pin](#Twig+pin)
     * [.pinned](#Twig+pinned) ⇒ <code>boolean</code>
     * [.close](#Twig+close)
+    * [.debug](#Twig+debug) ⇒ <code>string</code>
     * [.addChild](#Twig+addChild) ℗
     * [.writer](#Twig+writer) ⇒ [<code>XMLWriter</code>](https://www.npmjs.com/package/xml-writer)
     * [.attr](#Twig+attr) ⇒ <code>string</code> \| <code>number</code> \| <code>object</code>
@@ -964,6 +973,13 @@ Checks if element is pinned
 Closes the element
 
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
+<a name="Twig+debug"></a>
+
+### twig.debug ⇒ <code>string</code>
+XML-Twig for dummies :-)
+
+**Kind**: instance property of [<code>Twig</code>](#Twig)  
+**Returns**: <code>string</code> - The XML-Tree which is currently available in RAM - no valid XML Structure  
 <a name="Twig+addChild"></a>
 
 ### twig.addChild ℗

package/package.json

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

package/test.js

@@ -2,10 +2,10 @@ const fs = require('fs');
 const twig = require('./twig.js');
 
 
-//const parser = twig.createParser({ tag: twig.Any, function: anyHandler }, { method: "sax" });
+const parser = twig.createParser({ tag: twig.Any, function: anyHandler }, { method: "sax" });
 //const parser = twig.createParser({ tag: twig.Any, function: anyHandler }, { method: "expat" });
 //const parser = twig.createParser({ tag: twig.Any, function: anyHandler }, { method: "saxophone" });
-//fs.createReadStream(`${__dirname}/samples/bookstore.xml`).pipe(parser);
+fs.createReadStream(`${__dirname}/samples/bookstore.xml`).pipe(parser);
 //fs.createReadStream(`${__dirname}/samples/breakfast-menu.xml`).pipe(parser);
 
 //const parser = twig.createParser({ tag: twig.Any, function: nsHandler }, { method: "sax", xmlns: true });

package/twig.js

@@ -483,7 +483,6 @@ function reset() {
    current = undefined;
 }
 
-
 /**
  * Generic class modeling a XML Node
  * @class Twig
@@ -760,21 +759,29 @@ class Twig {
       Object.seal(this);
    };
 
+   /**
+   * XML-Twig for dummies :-)
+   * @returns {string} The XML-Tree which is currently available in RAM - no valid XML Structure
+   */
+   debug = function () {
+      return this.root().writer(true, true).output;
+   };
+
    /**
    * Internal recursive function used by `writer()`
    * @param {external:XMLWriter} xw - The writer object
    * @param {Twig[]} childArray - Array of child elements
    */
-   #addChild = function (xw, childArray) {
+   #addChild = function (xw, childArray, cur, debug) {
       for (let elt of childArray) {
          xw.startElement(elt.name);
          for (let [key, val] of Object.entries(elt.attributes))
             xw.writeAttribute(key, val);
          if (elt.text !== null)
             xw.text(elt.text);
-         this.#addChild(xw, elt.children());
+         this.#addChild(xw, elt.children(), elt, debug);         
       }
-      xw.endElement();
+      if (!debug || Object.isSealed(cur)) xw.endElement();
    };
 
    /**
@@ -782,7 +789,7 @@ class Twig {
    * @param {?boolean|string|external:XMLWriter} par - `true` or intention character or an already created XMLWriter
    * @returns {external:XMLWriter} 
    */
-   writer = function (par) {
+   writer = function (par, debug) {
       const XMLWriter = require('xml-writer');
       let xw = par instanceof XMLWriter ? par : new XMLWriter(par);
 
@@ -791,8 +798,8 @@ class Twig {
          xw.writeAttribute(key, val);
       if (this.#text !== null)
          xw.text(this.#text);
-      this.#addChild(xw, this.#children);
-      xw.endElement();
+      this.#addChild(xw, this.#children, this, debug);
+      if (!debug || Object.isSealed(this)) xw.endElement();
       return xw;
    };