xml-twig 1.3.3 → 1.3.5

package/README.md

@@ -33,7 +33,7 @@ npm install node-expat
 npm install saxophone
 
 ```
-In my tests I parsed a 900 MB big XML file, the `node-expat` is faster than `sax` (node-expat: around 2:50 Minutes, sax: around 4:10 Minutes). However, you may run into problems when you try to install the `node-expat` parser. That's the reason why `node-expat` parser is not installed automatically. `saxophone` is even a little faster (around 2:10 Minutes) than `node-expat`, however `saxophone` lacks some functions and is not fully compliant to XML standards.
+In my tests I parsed a 900 MB big XML file, the `node-expat` is faster than `sax` (node-expat: around 2:30 Minutes, sax: around 3:40 Minutes). However, you may run into problems when you try to install the `node-expat` parser. That's the reason why `node-expat` parser is not installed automatically. `saxophone` is even a little faster (around 2:10 Minutes) than `node-expat`, however `saxophone` lacks some functions and is not fully compliant to XML standards.
 
 ## How to use it
 

package/doc/twig.md

@@ -244,13 +244,13 @@ Purges the current, typically used after element has been processed.<br>The root
 <a name="Twig+purgeUpTo"></a>
 
 ### twig.purgeUpTo
-Purges up to the elt element. This allows you to keep part of the tree in memory when you purge.
+Purges up to the elt element. This allows you to keep part of the tree in memory when you purge.<br>
 
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| [elt] | [<code>Twig</code>](#Twig) | Up to this element the tree will be purged. The `elt` object itself is not purged.<br> If `undefined` then the current element is purged (i.e. `purge()`) |
+| [elt] | [<code>Twig</code>](#Twig) | Up to this element the tree will be purged. If `undefined` then the current element is purged (i.e. `purge()`) |
 
 <a name="Twig+escapeEntity"></a>
 
@@ -861,13 +861,13 @@ Purges the current, typically used after element has been processed.<br>The root
 <a name="Twig+purgeUpTo"></a>
 
 ### twig.purgeUpTo
-Purges up to the elt element. This allows you to keep part of the tree in memory when you purge.
+Purges up to the elt element. This allows you to keep part of the tree in memory when you purge.<br>
 
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| [elt] | [<code>Twig</code>](#Twig) | Up to this element the tree will be purged. The `elt` object itself is not purged.<br> If `undefined` then the current element is purged (i.e. `purge()`) |
+| [elt] | [<code>Twig</code>](#Twig) | Up to this element the tree will be purged. If `undefined` then the current element is purged (i.e. `purge()`) |
 
 <a name="Twig+escapeEntity"></a>
 

package/package.json

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

package/twig.js

@@ -29,7 +29,9 @@ let current;
 
 /**
 * @external libxmljs
-* @todo Not yet implemented, maybe later. Not sure if `WritableStream` is supported
+* Though module looks promising, it is not implemented, because it does not support Streams.
+* According to {@link https://github.com/libxmljs/libxmljs/issues/390|Stream Support} it was requested in 2016, i.e. 8 years ago. 
+* Apart from that, documentation is very sparse.
 * @see {@link https://www.npmjs.com/package/libxmljs|libxmljs}
 */
 
@@ -610,19 +612,17 @@ class Twig {
    };
 
    /**
-   * Purges up to the elt element. This allows you to keep part of the tree in memory when you purge.
-   * @param {Twig} [elt] - Up to this element the tree will be purged. The `elt` object itself is not purged.<br>
+   * Purges up to the elt element. This allows you to keep part of the tree in memory when you purge.<br>
+   * The `elt` object is not purged. If you like to purge including `elt`, use `.purgeUpTo(elt.previous())`
+   * @param {Twig} [elt] - Up to this element the tree will be purged.
    * If `undefined` then the current element is purged (i.e. `purge()`)
    */
    purgeUpTo = function (elt) {
       if (elt === undefined) {
          this.purge();
       } else {
-         const purgeThis = this.descendantOrSelf();
-         let toPurge = purgeThis[purgeThis.length - 1];
-         const descendantOrSelf = elt.descendantOrSelf();
-         const stopAt = descendantOrSelf[descendantOrSelf.length - 1];
-         while (toPurge !== null && !Object.is(toPurge, stopAt)) {
+         let toPurge = this;
+         while (toPurge !== null && !Object.is(toPurge, elt)) {
             const prev = toPurge.previous();
             toPurge.purge();
             toPurge = prev;