xml-twig 1.2.86 → 1.2.90

package/doc/twig.md

@@ -112,12 +112,12 @@ You can specify a <code>function</code> or a <code>event</code> name</p>
 * [Twig](#Twig)
     * [new Twig()](#new_Twig_new)
     * [new Twig(name, [parent], [attributes], [index])](#new_Twig_new)
-    * [.attributes](#Twig+attributes) ℗
-    * [.text](#Twig+text) ℗
-    * [.name](#Twig+name) ℗
-    * [.children](#Twig+children) ℗
-    * [.parent](#Twig+parent) ℗
-    * [.pinned](#Twig+pinned) ℗
+    * [.attributes](#Twig+attributes) : <code>object</code> ℗
+    * [.text](#Twig+text) : <code>string</code> \| <code>number</code> ℗
+    * [.name](#Twig+name) : <code>string</code> ℗
+    * [.children](#Twig+children) : [<code>Array.&lt;Twig&gt;</code>](#Twig) ℗
+    * [.parent](#Twig+parent) : [<code>Twig</code>](#Twig) \| <code>undefined</code> ℗
+    * [.pinned](#Twig+pinned) : <code>boolean</code> ℗
     * [.purge](#Twig+purge)
     * [.purgeUpTo](#Twig+purgeUpTo)
     * [.escapeEntity](#Twig+escapeEntity)
@@ -187,70 +187,46 @@ Create a new Twig object
 
 <a name="Twig+attributes"></a>
 
-### twig.attributes ℗
+### twig.attributes : <code>object</code> ℗
+XML attribute `{ <attribute 1>: <value 1>, <attribute 2>: <value 2>, ... }`
+
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Access**: private  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| #attributes | <code>object</code> | XML attribute `{ <attribute 1>: <value 1>, <attribute 2>: <value 2>, ... }` |
-
 <a name="Twig+text"></a>
 
-### twig.text ℗
+### twig.text : <code>string</code> \| <code>number</code> ℗
+Content of XML Element
+
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Access**: private  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| #text | <code>string</code> \| <code>number</code> | Content of XML Element |
-
 <a name="Twig+name"></a>
 
-### twig.name ℗
+### twig.name : <code>string</code> ℗
+The XML tag name
+
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Access**: private  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| #name | <code>string</code> | The XML tag name |
-
 <a name="Twig+children"></a>
 
-### twig.children ℗
+### twig.children : [<code>Array.&lt;Twig&gt;</code>](#Twig) ℗
+Child XML Elements
+
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Access**: private  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| #children | [<code>Array.&lt;Twig&gt;</code>](#Twig) | Child XML Elements |
-
 <a name="Twig+parent"></a>
 
-### twig.parent ℗
+### twig.parent : [<code>Twig</code>](#Twig) \| <code>undefined</code> ℗
+The parent object. Undefined on root element
+
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Access**: private  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| #parent | [<code>Twig</code>](#Twig) | The parent object. Undefined on root element |
-
 <a name="Twig+pinned"></a>
 
-### twig.pinned ℗
+### twig.pinned : <code>boolean</code> ℗
+Determines whether twig is needed in partial load
+
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Access**: private  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| #pinned | <code>boolean</code> | Determines whether twig is needed in partial load |
-
 <a name="Twig+purge"></a>
 
 ### twig.purge
@@ -745,12 +721,12 @@ Common function to filter Twig element
 * [Twig](#Twig)
     * [new Twig()](#new_Twig_new)
     * [new Twig(name, [parent], [attributes], [index])](#new_Twig_new)
-    * [.attributes](#Twig+attributes) ℗
-    * [.text](#Twig+text) ℗
-    * [.name](#Twig+name) ℗
-    * [.children](#Twig+children) ℗
-    * [.parent](#Twig+parent) ℗
-    * [.pinned](#Twig+pinned) ℗
+    * [.attributes](#Twig+attributes) : <code>object</code> ℗
+    * [.text](#Twig+text) : <code>string</code> \| <code>number</code> ℗
+    * [.name](#Twig+name) : <code>string</code> ℗
+    * [.children](#Twig+children) : [<code>Array.&lt;Twig&gt;</code>](#Twig) ℗
+    * [.parent](#Twig+parent) : [<code>Twig</code>](#Twig) \| <code>undefined</code> ℗
+    * [.pinned](#Twig+pinned) : <code>boolean</code> ℗
     * [.purge](#Twig+purge)
     * [.purgeUpTo](#Twig+purgeUpTo)
     * [.escapeEntity](#Twig+escapeEntity)
@@ -820,70 +796,46 @@ Create a new Twig object
 
 <a name="Twig+attributes"></a>
 
-### twig.attributes ℗
+### twig.attributes : <code>object</code> ℗
+XML attribute `{ <attribute 1>: <value 1>, <attribute 2>: <value 2>, ... }`
+
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Access**: private  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| #attributes | <code>object</code> | XML attribute `{ <attribute 1>: <value 1>, <attribute 2>: <value 2>, ... }` |
-
 <a name="Twig+text"></a>
 
-### twig.text ℗
+### twig.text : <code>string</code> \| <code>number</code> ℗
+Content of XML Element
+
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Access**: private  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| #text | <code>string</code> \| <code>number</code> | Content of XML Element |
-
 <a name="Twig+name"></a>
 
-### twig.name ℗
+### twig.name : <code>string</code> ℗
+The XML tag name
+
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Access**: private  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| #name | <code>string</code> | The XML tag name |
-
 <a name="Twig+children"></a>
 
-### twig.children ℗
+### twig.children : [<code>Array.&lt;Twig&gt;</code>](#Twig) ℗
+Child XML Elements
+
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Access**: private  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| #children | [<code>Array.&lt;Twig&gt;</code>](#Twig) | Child XML Elements |
-
 <a name="Twig+parent"></a>
 
-### twig.parent ℗
+### twig.parent : [<code>Twig</code>](#Twig) \| <code>undefined</code> ℗
+The parent object. Undefined on root element
+
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Access**: private  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| #parent | [<code>Twig</code>](#Twig) | The parent object. Undefined on root element |
-
 <a name="Twig+pinned"></a>
 
-### twig.pinned ℗
+### twig.pinned : <code>boolean</code> ℗
+Determines whether twig is needed in partial load
+
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Access**: private  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| #pinned | <code>boolean</code> | Determines whether twig is needed in partial load |
-
 <a name="Twig+purge"></a>
 
 ### twig.purge
@@ -1468,7 +1420,7 @@ Optional settings for the Twig parser
 
 | Name | Type | Description |
 | --- | --- | --- |
-| [method] | <code>string</code> | The underlying parser. Either `'sax'` or `'expat'`. |
+| [method] | <code>&#x27;sax&#x27;</code> \| <code>&#x27;expat&#x27;</code> | The underlying parser. Either `'sax'` or `'expat'`. |
 | [encoding] | <code>string</code> | Encoding of the XML File. Applies only to `expat` parser. |
 | [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. |
@@ -1517,9 +1469,8 @@ Custom filter function to specify when handler shall be called
 
 **Kind**: global typedef  
 **Returns**: <code>boolean</code> - If the function returns `true`, then it is included in the filter  
-**Properties**
 
-| Name | Type | Description |
+| Param | Type | Description |
 | --- | --- | --- |
 | name | <code>string</code> | Name of the element |
 

package/package.json

@@ -1,38 +1,38 @@
-{
-  "dependencies": {
-    "sax": "^1.3.0",
-    "xml-writer": "^1.7.0"
-  },
-  "name": "xml-twig",
-  "description": "Node module for processing huge XML documents in tree mode",
-  "version": "1.2.86",
-  "main": "twig.js",
-  "directories": {
-    "doc": "doc"
-  },
-  "devDependencies": {
-    "jsdoc-to-markdown": "^8.0.0",
-    "luxon": "^2.1.1",
-    "node-expat": "^2.4.0"
-  },
-  "scripts": {
-    "test": "node demo.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Wernfried/xml-twig.git"
-  },
-  "keywords": [
-    "xml",
-    "sax",
-    "expat",
-    "parser",
-    "xml-reader"
-  ],
-  "author": "Wernfried Domscheit",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/Wernfried/xml-twig/issues"
-  },
-  "homepage": "https://github.com/Wernfried/xml-twig#readme"
-}
+{
+  "dependencies": {
+    "sax": "^1.3.0",
+    "xml-writer": "^1.7.0"
+  },
+  "name": "xml-twig",
+  "description": "Node module for processing huge XML documents in tree mode",
+  "version": "1.2.90",
+  "main": "twig.js",
+  "directories": {
+    "doc": "doc"
+  },
+  "devDependencies": {
+    "jsdoc-to-markdown": "^8.0.0",
+    "luxon": "^2.1.1",
+    "node-expat": "^2.4.0"
+  },
+  "scripts": {
+    "test": "node demo.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Wernfried/xml-twig.git"
+  },
+  "keywords": [
+    "xml",
+    "sax",
+    "expat",
+    "parser",
+    "xml-reader"
+  ],
+  "author": "Wernfried Domscheit",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Wernfried/xml-twig/issues"
+  },
+  "homepage": "https://github.com/Wernfried/xml-twig#readme"
+}

package/twig.js

@@ -26,7 +26,7 @@ const Any = new AnyHandler();
 /**
 * Optional settings for the Twig parser
 * @typedef ParserOptions 
-* @property {string} [method] - The underlying parser. Either `'sax'` or `'expat'`.
+* @property {'sax' | 'expat'} [method] - The underlying parser. Either `'sax'` or `'expat'`.
 * @property {string} [encoding] - Encoding of the XML File. Applies only to `expat` parser.
 * @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.
@@ -41,9 +41,9 @@ const Any = new AnyHandler();
 * Element can be specified as string, Regular Expression, custom function, `Twig.Root` or `Twig.Any`<br> 
 * You can specify a `function` or a `event` name
 * @typedef TwigHandler
-* @property {?HandlerCondition} tag - Element specification
+* @property {HandlerCondition} tag - Element specification
 * @property {HandlerFunction} [function] - Definition of handler function, either anonymous or explicit function
-* @property {?string} [event] - Type of the event to be emitted
+* @property {string} [event] - Type of the event to be emitted
 */
 
 /**
@@ -65,8 +65,8 @@ const Any = new AnyHandler();
 
 /**
 * Custom filter function to specify when handler shall be called
-* @typedef HandlerConditionFilter 
-* @property {string} name - Name of the element
+* @typedef {function} HandlerConditionFilter 
+* @param {string} name - Name of the element
 * @returns {boolean} If the function returns `true`, then it is included in the filter
 */
 
@@ -103,8 +103,8 @@ function createParser(handler, options) {
    let closeEvent;
 
    if (options.partial) {
-      let hndl = Array.isArray(handler) ? handler : [handler];
-      let any = hndl.find(x => x.tag instanceof AnyHandler);
+      const handle1 = Array.isArray(handler) ? handler : [handler];
+      let any = handle1.find(x => x.tag instanceof AnyHandler);
       if (any !== undefined)
          console.warn(`Using option '{ partial: true }' and handler '{ tag: Any, function: ${any.function.toString()} }' does not make much sense`);
    }
@@ -391,38 +391,38 @@ class Twig {
    */
 
    /**
-   * @property {?object} #attributes - XML attribute `{ <attribute 1>: <value 1>, <attribute 2>: <value 2>, ... }`
-   * @private
+    * XML attribute `{ <attribute 1>: <value 1>, <attribute 2>: <value 2>, ... }`
+   * @type {?object}
    */
    #attributes = {};
 
    /**
-   * @property {?string|number} #text - Content of XML Element
-   * @private
+    * Content of XML Element
+   * @type {?string|number}
    */
    #text = null;
 
    /**
-   * @property {string} #name - The XML tag name
-   * @private
+    * The XML tag name
+   * @type {string} 
    */
    #name;
 
    /**
-   * @property {?Twig[]} #children - Child XML Elements
-   * @private
+    * Child XML Elements
+   * @type {Twig[]}
    */
    #children = [];
 
    /**
-   * @property {?Twig} #parent - The parent object. Undefined on root element
-   * @private
+    * The parent object. Undefined on root element
+   * @type {Twig | undefined} 
    */
    #parent;
 
    /**
-   * @property {boolean} #pinned - Determines whether twig is needed in partial load
-   * @private
+    * Determines whether twig is needed in partial load
+   * @type {boolean}
    */
    #pinned = false;
 
@@ -482,14 +482,14 @@ class Twig {
       if (elt === undefined) {
          this.purge();
       } else {
-         let purgeThis = this.descendantOrSelf();
-         purgeThis = purgeThis[purgeThis.length - 1];
-         let stopAt = elt.descendantOrSelf();
-         stopAt = stopAt[stopAt.length - 1];
-         while (purgeThis !== null && !Object.is(purgeThis, stopAt)) {
-            let prev = purgeThis.previous();
-            purgeThis.purge();
-            purgeThis = prev;
+         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)) {
+            const prev = toPurge.previous();
+            toPurge.purge();
+            toPurge = prev;
          }
       }
    };
@@ -784,7 +784,7 @@ class Twig {
          if (typeof condition === 'string') {
             return elements.filter(x => x.name === condition);
          } else if (condition instanceof RegExp) {
-            return elements.filter(x => x.condition.test(x.name));
+            return elements.filter(x => condition.test(x.name));
          } else if (condition instanceof Twig) {
             return elements.filter(x => Object.is(x, condition));
          } else if (typeof condition === 'function') {