npm - xml-twig - Versions diffs - 1.7.12 → 1.7.13 - Mend

xml-twig 1.7.12 → 1.7.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/doc/twig.md CHANGED Viewed

@@ -33,7 +33,7 @@
 ## Functions
 <dl>
-<dt><a href="#createParser">createParser(handler, [options])</a> ⇒ <code><a href="#Parser">Parser</a></code></dt>
+<dt><a href="#createParser">createParser(handler, options)</a> ⇒ <code><a href="#Parser">Parser</a></code></dt>
 <dd><p>Create a new Twig parser</p>
 </dd>
 <dt><a href="#onStart">onStart(parser, binds, node, attrs)</a></dt>
@@ -120,7 +120,7 @@ You can specify a <code>function</code> or a <code>event</code> name</p>
 * [Twig](#Twig)
     * [new Twig()](#new_Twig_new)
-    * [new Twig(parser, name, [parent], [attributes], [index])](#new_Twig_new)
+    * [new Twig(parser, name, parent, attributes, index)](#new_Twig_new)
     * [.attributes](#Twig+attributes) : <code>object</code> ℗
     * [.text](#Twig+text) : <code>string</code> \| <code>number</code> ℗
     * [.name](#Twig+name) : <code>string</code> ℗
@@ -176,8 +176,8 @@ You can specify a <code>function</code> or a <code>event</code> name</p>
     * [.addElement](#Twig+addElement) ⇒ [<code>Twig</code>](#Twig)
     * [.delete](#Twig+delete)
     * [.setRoot(name)](#Twig+setRoot) ℗
-    * [.filterElements(elements, [condition])](#Twig+filterElements) ⇒ [<code>Array.&lt;Twig&gt;</code>](#Twig)
-    * [.testElement(element, [condition])](#Twig+testElement) ⇒ <code>boolean</code>
+    * [.filterElements(elements, condition)](#Twig+filterElements) ⇒ [<code>Array.&lt;Twig&gt;</code>](#Twig)
+    * [.testElement(element, condition)](#Twig+testElement) ⇒ <code>boolean</code>
 <a name="new_Twig_new"></a>
@@ -186,7 +186,7 @@ Generic class modeling a XML Node
 <a name="new_Twig_new"></a>
-### new Twig(parser, name, [parent], [attributes], [index])
+### new Twig(parser, name, parent, attributes, index)
 Create a new Twig object
@@ -194,9 +194,9 @@ Create a new Twig object
 | --- | --- | --- |
 | parser | [<code>Parser</code>](#Parser) | The main parser object |
 | name | <code>string</code> | The name of the XML element |
-| [parent] | [<code>Twig</code>](#Twig) | The parent object |
-| [attributes] | <code>object</code> | Attribute object |
-| [index] | <code>string</code> \| <code>number</code> | Position name 'first', 'last' or the position in the current `children` array.<br>Defaults to 'last' |
+| parent | [<code>Twig</code>](#Twig) | The parent object |
+| attributes | <code>object</code> | Attribute object |
+| index | <code>string</code> \| <code>number</code> | Position name 'first', 'last' or the position in the current `children` array.<br>Defaults to 'last' |
 <a name="Twig+attributes"></a>
@@ -255,7 +255,7 @@ Purges up to the elt element. This allows you to keep part of the tree in memory
 | Param | Type | Description |
 | --- | --- | --- |
-| [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()`) |
+| 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>
@@ -413,7 +413,7 @@ Returns attribute value or `null` if not found.<br>
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>AttributeCondition</code>](#AttributeCondition) | Optional condition to select attribute |
+| condition | [<code>AttributeCondition</code>](#AttributeCondition) | Optional condition to select attribute |
 <a name="Twig+attributes"></a>
@@ -444,8 +444,8 @@ Retrieve or update XML attribute. For update, the condition must be a string, i.
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>AttributeCondition</code>](#AttributeCondition) | Optional condition to select attributes |
-| [value] | <code>string</code> \| <code>number</code> \| <code>bigint</code> \| <code>boolean</code> | New value of the attribute.<br>If `undefined` then existing attributes is returned. |
+| condition | [<code>AttributeCondition</code>](#AttributeCondition) | Optional condition to select attributes |
+| value | <code>string</code> \| <code>number</code> \| <code>bigint</code> \| <code>boolean</code> | New value of the attribute.<br>If `undefined` then existing attributes is returned. |
 **Example**
 ```js
@@ -490,7 +490,7 @@ All children, optionally matching `condition` of the current element or empty ar
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+next"></a>
@@ -503,7 +503,7 @@ Returns the next matching element.
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+previous"></a>
@@ -516,7 +516,7 @@ Returns the previous matching element.
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+first"></a>
@@ -528,7 +528,7 @@ Returns the first matching element. This is usually the root element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+last"></a>
@@ -540,7 +540,7 @@ Returns the last matching element.
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+isFirstChild"></a>
@@ -566,7 +566,7 @@ Returns descendants (children, grandchildren, etc.) of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+descendantOrSelf"></a>
@@ -578,7 +578,7 @@ Returns descendants (children, grandchildren, etc.) of the current element and t
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+ancestor"></a>
@@ -590,7 +590,7 @@ Returns ancestors (parent, grandparent, etc.)  of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+ancestorOrSelf"></a>
@@ -602,7 +602,7 @@ Returns ancestors (parent, grandparent, etc.)  of the current element and the cu
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+sibling"></a>
@@ -614,7 +614,7 @@ Returns all sibling element of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+siblingOrSelf"></a>
@@ -626,7 +626,7 @@ Returns all sibling element of the current element and the current element itsel
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+followingSibling"></a>
@@ -638,7 +638,7 @@ Returns all following sibling element of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+precedingSibling"></a>
@@ -650,7 +650,7 @@ Returns all preceding sibling element of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+nextSibling"></a>
@@ -662,7 +662,7 @@ Returns next sibling element of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+prevSibling"></a>
@@ -674,7 +674,7 @@ Returns previous sibling element of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+find"></a>
@@ -699,9 +699,9 @@ Add a new element in the current element
 | Param | Type | Description |
 | --- | --- | --- |
 | name | <code>string</code> | The tag name |
-| [text] | <code>string</code> | Text of the element |
-| [attributes] | <code>object</code> | Element attributes |
-| [position] | <code>name</code> \| <code>number</code> | Position name 'first', 'last' or the position in the `children` |
+| text | <code>string</code> | Text of the element |
+| attributes | <code>object</code> | Element attributes |
+| position | <code>name</code> \| <code>number</code> | Position name 'first', 'last' or the position in the `children` |
 <a name="Twig+delete"></a>
@@ -723,7 +723,7 @@ Sets the name of root element. In some cases the root is created before the XML-
 <a name="Twig+filterElements"></a>
-### twig.filterElements(elements, [condition]) ⇒ [<code>Array.&lt;Twig&gt;</code>](#Twig)
+### twig.filterElements(elements, condition) ⇒ [<code>Array.&lt;Twig&gt;</code>](#Twig)
 Common function to filter Twig elements from array
 **Kind**: instance method of [<code>Twig</code>](#Twig)
@@ -732,11 +732,11 @@ Common function to filter Twig elements from array
 | Param | Type | Description |
 | --- | --- | --- |
 | elements | [<code>Twig</code>](#Twig) \| [<code>Array.&lt;Twig&gt;</code>](#Twig) | Array of elements you like to filter or a single element |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | The filter condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | The filter condition |
 <a name="Twig+testElement"></a>
-### twig.testElement(element, [condition]) ⇒ <code>boolean</code>
+### twig.testElement(element, condition) ⇒ <code>boolean</code>
 Common function to filter Twig element
 **Kind**: instance method of [<code>Twig</code>](#Twig)
@@ -745,7 +745,7 @@ Common function to filter Twig element
 | Param | Type | Description |
 | --- | --- | --- |
 | element | [<code>Twig</code>](#Twig) | Element you like to filter |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | The filter condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | The filter condition |
 <a name="Twig"></a>
@@ -754,7 +754,7 @@ Common function to filter Twig element
 * [Twig](#Twig)
     * [new Twig()](#new_Twig_new)
-    * [new Twig(parser, name, [parent], [attributes], [index])](#new_Twig_new)
+    * [new Twig(parser, name, parent, attributes, index)](#new_Twig_new)
     * [.attributes](#Twig+attributes) : <code>object</code> ℗
     * [.text](#Twig+text) : <code>string</code> \| <code>number</code> ℗
     * [.name](#Twig+name) : <code>string</code> ℗
@@ -810,8 +810,8 @@ Common function to filter Twig element
     * [.addElement](#Twig+addElement) ⇒ [<code>Twig</code>](#Twig)
     * [.delete](#Twig+delete)
     * [.setRoot(name)](#Twig+setRoot) ℗
-    * [.filterElements(elements, [condition])](#Twig+filterElements) ⇒ [<code>Array.&lt;Twig&gt;</code>](#Twig)
-    * [.testElement(element, [condition])](#Twig+testElement) ⇒ <code>boolean</code>
+    * [.filterElements(elements, condition)](#Twig+filterElements) ⇒ [<code>Array.&lt;Twig&gt;</code>](#Twig)
+    * [.testElement(element, condition)](#Twig+testElement) ⇒ <code>boolean</code>
 <a name="new_Twig_new"></a>
@@ -820,7 +820,7 @@ Generic class modeling a XML Node
 <a name="new_Twig_new"></a>
-### new Twig(parser, name, [parent], [attributes], [index])
+### new Twig(parser, name, parent, attributes, index)
 Create a new Twig object
@@ -828,9 +828,9 @@ Create a new Twig object
 | --- | --- | --- |
 | parser | [<code>Parser</code>](#Parser) | The main parser object |
 | name | <code>string</code> | The name of the XML element |
-| [parent] | [<code>Twig</code>](#Twig) | The parent object |
-| [attributes] | <code>object</code> | Attribute object |
-| [index] | <code>string</code> \| <code>number</code> | Position name 'first', 'last' or the position in the current `children` array.<br>Defaults to 'last' |
+| parent | [<code>Twig</code>](#Twig) | The parent object |
+| attributes | <code>object</code> | Attribute object |
+| index | <code>string</code> \| <code>number</code> | Position name 'first', 'last' or the position in the current `children` array.<br>Defaults to 'last' |
 <a name="Twig+attributes"></a>
@@ -889,7 +889,7 @@ Purges up to the elt element. This allows you to keep part of the tree in memory
 | Param | Type | Description |
 | --- | --- | --- |
-| [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()`) |
+| 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>
@@ -1047,7 +1047,7 @@ Returns attribute value or `null` if not found.<br>
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>AttributeCondition</code>](#AttributeCondition) | Optional condition to select attribute |
+| condition | [<code>AttributeCondition</code>](#AttributeCondition) | Optional condition to select attribute |
 <a name="Twig+attributes"></a>
@@ -1078,8 +1078,8 @@ Retrieve or update XML attribute. For update, the condition must be a string, i.
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>AttributeCondition</code>](#AttributeCondition) | Optional condition to select attributes |
-| [value] | <code>string</code> \| <code>number</code> \| <code>bigint</code> \| <code>boolean</code> | New value of the attribute.<br>If `undefined` then existing attributes is returned. |
+| condition | [<code>AttributeCondition</code>](#AttributeCondition) | Optional condition to select attributes |
+| value | <code>string</code> \| <code>number</code> \| <code>bigint</code> \| <code>boolean</code> | New value of the attribute.<br>If `undefined` then existing attributes is returned. |
 **Example**
 ```js
@@ -1124,7 +1124,7 @@ All children, optionally matching `condition` of the current element or empty ar
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+next"></a>
@@ -1137,7 +1137,7 @@ Returns the next matching element.
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+previous"></a>
@@ -1150,7 +1150,7 @@ Returns the previous matching element.
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+first"></a>
@@ -1162,7 +1162,7 @@ Returns the first matching element. This is usually the root element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+last"></a>
@@ -1174,7 +1174,7 @@ Returns the last matching element.
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+isFirstChild"></a>
@@ -1200,7 +1200,7 @@ Returns descendants (children, grandchildren, etc.) of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+descendantOrSelf"></a>
@@ -1212,7 +1212,7 @@ Returns descendants (children, grandchildren, etc.) of the current element and t
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+ancestor"></a>
@@ -1224,7 +1224,7 @@ Returns ancestors (parent, grandparent, etc.)  of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+ancestorOrSelf"></a>
@@ -1236,7 +1236,7 @@ Returns ancestors (parent, grandparent, etc.)  of the current element and the cu
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+sibling"></a>
@@ -1248,7 +1248,7 @@ Returns all sibling element of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+siblingOrSelf"></a>
@@ -1260,7 +1260,7 @@ Returns all sibling element of the current element and the current element itsel
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+followingSibling"></a>
@@ -1272,7 +1272,7 @@ Returns all following sibling element of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+precedingSibling"></a>
@@ -1284,7 +1284,7 @@ Returns all preceding sibling element of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+nextSibling"></a>
@@ -1296,7 +1296,7 @@ Returns next sibling element of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+prevSibling"></a>
@@ -1308,7 +1308,7 @@ Returns previous sibling element of the current element
 | Param | Type | Description |
 | --- | --- | --- |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | Optional condition |
 <a name="Twig+find"></a>
@@ -1333,9 +1333,9 @@ Add a new element in the current element
 | Param | Type | Description |
 | --- | --- | --- |
 | name | <code>string</code> | The tag name |
-| [text] | <code>string</code> | Text of the element |
-| [attributes] | <code>object</code> | Element attributes |
-| [position] | <code>name</code> \| <code>number</code> | Position name 'first', 'last' or the position in the `children` |
+| text | <code>string</code> | Text of the element |
+| attributes | <code>object</code> | Element attributes |
+| position | <code>name</code> \| <code>number</code> | Position name 'first', 'last' or the position in the `children` |
 <a name="Twig+delete"></a>
@@ -1357,7 +1357,7 @@ Sets the name of root element. In some cases the root is created before the XML-
 <a name="Twig+filterElements"></a>
-### twig.filterElements(elements, [condition]) ⇒ [<code>Array.&lt;Twig&gt;</code>](#Twig)
+### twig.filterElements(elements, condition) ⇒ [<code>Array.&lt;Twig&gt;</code>](#Twig)
 Common function to filter Twig elements from array
 **Kind**: instance method of [<code>Twig</code>](#Twig)
@@ -1366,11 +1366,11 @@ Common function to filter Twig elements from array
 | Param | Type | Description |
 | --- | --- | --- |
 | elements | [<code>Twig</code>](#Twig) \| [<code>Array.&lt;Twig&gt;</code>](#Twig) | Array of elements you like to filter or a single element |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | The filter condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | The filter condition |
 <a name="Twig+testElement"></a>
-### twig.testElement(element, [condition]) ⇒ <code>boolean</code>
+### twig.testElement(element, condition) ⇒ <code>boolean</code>
 Common function to filter Twig element
 **Kind**: instance method of [<code>Twig</code>](#Twig)
@@ -1379,7 +1379,7 @@ Common function to filter Twig element
 | Param | Type | Description |
 | --- | --- | --- |
 | element | [<code>Twig</code>](#Twig) | Element you like to filter |
-| [condition] | [<code>ElementCondition</code>](#ElementCondition) | The filter condition |
+| condition | [<code>ElementCondition</code>](#ElementCondition) | The filter condition |
 <a name="NotImplementedYet"></a>
@@ -1446,7 +1446,7 @@ Generic error for unsupported condition
 ## SAX
 **Kind**: global constant
-**Version:**: 1.7.11
+**Version:**: 1.7.12
 **Author:**: Wernfried Domscheit
 **Copyright:**: Copyright (c) 2025 Wernfried Domscheit. All rights reserved.
 **Website:**: https://www.npmjs.com/package/xml-twig
@@ -1460,7 +1460,7 @@ Generic error for unsupported condition
 **Kind**: global constant
 <a name="createParser"></a>
-## createParser(handler, [options]) ⇒ [<code>Parser</code>](#Parser)
+## createParser(handler, options) ⇒ [<code>Parser</code>](#Parser)
 Create a new Twig parser
 **Kind**: global function
@@ -1473,7 +1473,7 @@ Create a new Twig parser
 | Param | Type | Description |
 | --- | --- | --- |
 | handler | [<code>TwigHandler</code>](#TwigHandler) \| [<code>Array.&lt;TwigHandler&gt;</code>](#TwigHandler) | Object or array of element specification and function to handle elements |
-| [options] | [<code>ParserOptions</code>](#ParserOptions) | Object of optional options |
+| options | [<code>ParserOptions</code>](#ParserOptions) | Object of optional options |
 <a name="onStart"></a>
@@ -1515,12 +1515,12 @@ Optional settings for the Twig parser
 | Name | Type | Description |
 | --- | --- | --- |
-| [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. |
-| [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. |
+| 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. |
+| 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. |
 **Example**
 ```js
@@ -1537,8 +1537,8 @@ Reference to handler functions for Twig objects.<br>
 | Name | Type | Description |
 | --- | --- | --- |
 | tag | [<code>HandlerCondition</code>](#HandlerCondition) | Element specification |
-| [function] | [<code>HandlerFunction</code>](#HandlerFunction) | Definition of handler function, either anonymous or explicit function |
-| [event] | <code>string</code> | Type of the event to be emitted |
+| function | [<code>HandlerFunction</code>](#HandlerFunction) | Definition of handler function, either anonymous or explicit function |
+| event | <code>string</code> | Type of the event to be emitted |
 <a name="HandlerCondition"></a>
@@ -1597,11 +1597,11 @@ Custom filter function to select desired elements
 | Name | Type | Description |
 | --- | --- | --- |
-| [currentLine] | <code>number</code> | The currently processed line in the XML-File. |
-| [currentColumn] | <code>number</code> | The currently processed column in the XML-File. |
-| [file] | <code>string</code> | The name of file to be parsed. Just used for information and logging purpose. |
-| [twig] | <code>object</code> | Object with XML tree and current XML element |
-| [method] | <code>string</code> | The underlying parser. Either `'sax'`, `'expat'`. |
+| currentLine | <code>number</code> | The currently processed line in the XML-File. |
+| currentColumn | <code>number</code> | The currently processed column in the XML-File. |
+| file | <code>string</code> | The name of file to be parsed. Just used for information and logging purpose. |
+| twig | <code>object</code> | Object with XML tree and current XML element |
+| method | <code>string</code> | The underlying parser. Either `'sax'`, `'expat'`. |
 <a name="AttributeCondition"></a>

package/package.json CHANGED Viewed

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

package/twig.js CHANGED Viewed

@@ -1,5 +1,5 @@
 /**
-* @version: 1.7.12
+* @version: 1.7.13
 * @author: Wernfried Domscheit
 * @copyright: Copyright (c) 2025 Wernfried Domscheit. All rights reserved.
 * @website: https://www.npmjs.com/package/xml-twig
@@ -62,12 +62,12 @@ const Any = new AnyHandler();
 /**
 * Optional settings for the Twig parser
 * @typedef ParserOptions
-* @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} [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.
+* @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} 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 }
 * @default  { method: 'sax', xmlns: false, trim: true, resumeAfterError: false, partial: false }
 */
@@ -78,8 +78,8 @@ const Any = new AnyHandler();
 * You can specify a `function` or a `event` name
 * @typedef TwigHandler
 * @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 {HandlerFunction} function - Definition of handler function, either anonymous or explicit function
+* @property {string} event - Type of the event to be emitted
 */
 /**
@@ -126,18 +126,18 @@ const Any = new AnyHandler();
 /**
 * @typedef Parser
-* @property {number} [currentLine] - The currently processed line in the XML-File.
-* @property {number} [currentColumn] - The currently processed column in the XML-File.
-* @property {string} [file] - The name of file to be parsed. Just used for information and logging purpose.
-* @property {object} [twig] - Object with XML tree and current XML element
-* @property {string} [method] - The underlying parser. Either `'sax'`, `'expat'`.
+* @property {number} currentLine - The currently processed line in the XML-File.
+* @property {number} currentColumn - The currently processed column in the XML-File.
+* @property {string} file - The name of file to be parsed. Just used for information and logging purpose.
+* @property {object} twig - Object with XML tree and current XML element
+* @property {string} method - The underlying parser. Either `'sax'`, `'expat'`.
 * @returns {external:sax|external:node-expat} The parser Object
 */
 /**
 * Create a new Twig parser
 * @param {TwigHandler|TwigHandler[]} handler - Object or array of element specification and function to handle elements
-* @param {ParserOptions} [options] - Object of optional options
+* @param {ParserOptions} options - Object of optional options
 * @throws {UnsupportedParser} - For an unsupported parser. Currently `expat` and `sax` (default) are supported.
 * @returns {Parser} The parser Object
 */
@@ -517,9 +517,9 @@ class Twig {
    * Create a new Twig object
    * @param {Parser} parser - The main parser object
    * @param {?string} name - The name of the XML element
-   * @param {Twig} [parent] - The parent object
-   * @param {object} [attributes] - Attribute object
-   * @param {string|number} [index] - Position name 'first', 'last' or the position in the current `children` array.<br>Defaults to 'last'
+   * @param {Twig} parent - The parent object
+   * @param {object} attributes - Attribute object
+   * @param {string|number} index - Position name 'first', 'last' or the position in the current `children` array.<br>Defaults to 'last'
    */
    constructor(parser, name, parent, attributes, index) {
       if (index === undefined)
@@ -564,7 +564,7 @@ class Twig {
    /**
    * 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.
+   * @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) {
@@ -797,7 +797,7 @@ class Twig {
    /**
    * Returns attribute value or `null` if not found.<br>
    * If more than one  matches the condition, then it returns object as [attribute()](#attribute)
-   * @param {AttributeCondition} [condition] - Optional condition to select attribute
+   * @param {AttributeCondition} condition - Optional condition to select attribute
    * @returns {?string|number|object} - The value of the attribute or `null` if the  does not exist
    */
    attr = function (condition) {
@@ -827,8 +827,8 @@ class Twig {
    /**
    * Retrieve or update XML attribute. For update, the condition must be a string, i.e. must match to one attribute only.
-   * @param {AttributeCondition} [condition] - Optional condition to select attributes
-   * @param {string|number|bigint|boolean} [value] - New value of the attribute.<br>If `undefined` then existing attributes is returned.
+   * @param {AttributeCondition} condition - Optional condition to select attributes
+   * @param {string|number|bigint|boolean} value - New value of the attribute.<br>If `undefined` then existing attributes is returned.
    * @returns {object} Attributes or `null` if no matching attribute found
    * @example attribute((name, val) => { return name === 'age' && val > 50})
    * attribute((name) => { return ['firstName', 'lastName'].includes(name) })
@@ -906,7 +906,7 @@ class Twig {
    /**
    * Common function to filter Twig elements from array
    * @param {Twig|Twig[]} elements - Array of elements you like to filter or a single element
-   * @param {ElementCondition} [condition] - The filter condition
+   * @param {ElementCondition} condition - The filter condition
    * @returns {Twig[]} List of matching elements or empty array
    */
    filterElements(elements, condition) {
@@ -931,7 +931,7 @@ class Twig {
    /**
    * Common function to filter Twig element
    * @param {Twig} element - Element you like to filter
-   * @param {ElementCondition} [condition] - The filter condition
+   * @param {ElementCondition} condition - The filter condition
    * @returns {boolean} `true` if the condition matches
    */
    testElement(element, condition) {
@@ -951,7 +951,7 @@ class Twig {
    /**
    * All children, optionally matching `condition` of the current element or empty array
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {Twig[]}
    */
    children = function (condition) {
@@ -960,7 +960,7 @@ class Twig {
    /**
    * Returns the next matching element.
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {?Twig} - The next element
    * @see https://www.w3.org/TR/xpath-datamodel-31/#document-order
    */
@@ -986,7 +986,7 @@ class Twig {
    /**
    * Returns the previous matching element.
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {?Twig} - The previous element
    * @see https://www.w3.org/TR/xpath-datamodel-31/#document-order
    */
@@ -1007,7 +1007,7 @@ class Twig {
    /**
    * Returns the first matching element. This is usually the root element
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {?Twig} - The first element
    */
    first = function (condition) {
@@ -1018,7 +1018,7 @@ class Twig {
    /**
    * Returns the last matching element.
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {?Twig} - The last element
    */
    last = function (condition) {
@@ -1061,7 +1061,7 @@ class Twig {
    /**
    * Returns descendants (children, grandchildren, etc.) of the current element
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {Twig[]} - Array of descendants or empty array
    */
    descendant = function (condition) {
@@ -1075,7 +1075,7 @@ class Twig {
    /**
    * Returns descendants (children, grandchildren, etc.) of the current element and the current element itself
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {Twig[]} - Array of descendants or empty array
    */
    descendantOrSelf = function (condition) {
@@ -1089,7 +1089,7 @@ class Twig {
    /**
    * Returns ancestors (parent, grandparent, etc.)  of the current element
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {Twig[]} - Array of ancestors or empty array
    */
    ancestor = function (condition) {
@@ -1107,7 +1107,7 @@ class Twig {
    /**
    * Returns ancestors (parent, grandparent, etc.)  of the current element and the current element itself
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {Twig[]} - Array of ancestors or empty array
    */
    ancestorOrSelf = function (condition) {
@@ -1125,7 +1125,7 @@ class Twig {
    /**
    * Returns all sibling element of the current element
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {Twig[]} - Array of sibling or empty array
    */
    sibling = function (condition) {
@@ -1138,7 +1138,7 @@ class Twig {
    /**
    * Returns all sibling element of the current element and the current element itself
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {Twig[]} - Array of sibling or empty array
    */
    siblingOrSelf = function (condition) {
@@ -1151,7 +1151,7 @@ class Twig {
    /**
    * Returns all following sibling element of the current element
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {Twig[]} - Array of sibling or empty array
    */
    followingSibling = function (condition) {
@@ -1164,7 +1164,7 @@ class Twig {
    /**
    * Returns all preceding sibling element of the current element
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {Twig[]} - Array of sibling or empty array
    */
    precedingSibling = function (condition) {
@@ -1177,7 +1177,7 @@ class Twig {
    /**
    * Returns next sibling element of the current element
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {?Twig} - The next sibling or `null`
    */
    nextSibling = function (condition) {
@@ -1192,7 +1192,7 @@ class Twig {
    /**
    * Returns previous sibling element of the current element
-   * @param {ElementCondition} [condition] - Optional condition
+   * @param {ElementCondition} condition - Optional condition
    * @returns {?Twig} - The previous sibling or `null`
    */
    prevSibling = function (condition) {
@@ -1225,9 +1225,9 @@ class Twig {
    /**
    * Add a new element in the current element
    * @param {string} name - The tag name
-   * @param {?string} [text] - Text of the element
-   * @param {?object} [attributes] - Element attributes
-   * @param {name|number} [position] - Position name 'first', 'last' or the position in the `children`
+   * @param {?string} text - Text of the element
+   * @param {?object} attributes - Element attributes
+   * @param {name|number} position - Position name 'first', 'last' or the position in the `children`
    * @returns {Twig} - The appended element
    */
    addElement = function (parser, name, text, attributes, position) {