data-restructor 3.4.0 → 3.4.2

package/docs/module-template_resolver.Resolver.html

@@ -265,7 +265,7 @@
     
 
     
-    <h4 class="name" id=".addFieldsPerGroup"><span class="type-signature">(protected, static) </span>addFieldsPerGroup<span class="signature">(object)</span><span class="type-signature"> &rarr; {object}</span></h4>
+    <h4 class="name" id="replaceResolvableFields"><span class="type-signature"></span>replaceResolvableFields<span class="signature">(stringContainingVariables, resolvableFields)</span><span class="type-signature"></span></h4>
     
 
     
@@ -273,8 +273,9 @@
 
 
 <div class="description">
-    <p>Adds the value of the &quot;fieldName&quot; property (including its group prefix) and its associated &quot;value&quot; property content.
-For example: detail[2].fieldName=&quot;name&quot;, detail[2].value=&quot;Smith&quot; lead to the additional property detail.name=&quot;Smith&quot;.</p>
+    <p>Replaces all variables in double curly brackets, e.g. {{property}},
+with the value of that property from the resolvableProperties.</p>
+<p>Supported property types: string, number, boolean</p>
 </div>
 
 
@@ -310,13 +311,13 @@ For example: detail[2].fieldName=&quot;name&quot;, detail[2].value=&quot;Smith&q
 
         <tr>
             
-                <td class="name"><code>object</code></td>
+                <td class="name"><code>stringContainingVariables</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">object</span>
+<span class="param-type">string</span>
 
 
             
@@ -326,7 +327,30 @@ For example: detail[2].fieldName=&quot;name&quot;, detail[2].value=&quot;Smith&q
 
             
 
-            <td class="description last"><p>with resolvable field names and their values.</p></td>
+            <td class="description last"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>resolvableFields</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;object></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>(name=value)</p></td>
         </tr>
 
     
@@ -367,7 +391,7 @@ For example: detail[2].fieldName=&quot;name&quot;, detail[2].value=&quot;Smith&q
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="templateResolver.js.html">templateResolver.js</a>, <a href="templateResolver.js.html#line107">line 107</a>
+        <a href="templateResolver.js.html">templateResolver.js</a>, <a href="templateResolver.js.html#line84">line 84</a>
     </li></ul></dd>
     
 
@@ -392,28 +416,6 @@ For example: detail[2].fieldName=&quot;name&quot;, detail[2].value=&quot;Smith&q
 
 
 
-<h5>Returns:</h5>
-
-        
-<div class="param-desc">
-    <p>object with resolvable field names and their values.</p>
-</div>
-
-
-
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type">object</span>
-
-
-    </dd>
-</dl>
-
-    
 
 
 
@@ -425,7 +427,7 @@ For example: detail[2].fieldName=&quot;name&quot;, detail[2].value=&quot;Smith&q
     
 
     
-    <h4 class="name" id=".addToFilteredMapObject"><span class="type-signature">(protected, static) </span>addToFilteredMapObject<span class="signature">(elements, mapObject, filterMatchesFunction)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="resolvableFieldsOfAll"><span class="type-signature"></span>resolvableFieldsOfAll<span class="signature">(&hellip;varArgs)</span><span class="type-signature"> &rarr; {object}</span></h4>
     
 
     
@@ -433,8 +435,12 @@ For example: detail[2].fieldName=&quot;name&quot;, detail[2].value=&quot;Smith&q
 
 
 <div class="description">
-    <p>Collects all flattened name-value-pairs into one object using the property names as keys and their values as values (map-like).
-Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code> becomes <code>mapObject[&quot;accountNumber&quot;]=&quot;12345&quot;</code>.</p>
+    <p>Returns a map like object, that contains all resolvable fields and their values as properties.
+This function takes a variable count of input parameters,
+each containing an object that contains resolvable fields to extract from.</p>
+<p>The recursion depth is limited to 3, so that an object,
+that contains an object can contain another object (but not further).</p>
+<p>Properties beginning with an underscore in their name will be filtered out, since they are considered as internal fields.</p>
 </div>
 
 
@@ -458,6 +464,8 @@ Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code
         <th>Type</th>
 
         
+        <th>Attributes</th>
+        
 
         
 
@@ -470,30 +478,7 @@ Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code
 
         <tr>
             
-                <td class="name"><code>elements</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">Array.&lt;NameValuePair></span>
-
-
-            
-            </td>
-
-            
-
-            
-
-            <td class="description last"><p>flattened array of name-value-pairs</p></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>mapObject</code></td>
+                <td class="name"><code>varArgs</code></td>
             
 
             <td class="type">
@@ -506,33 +491,20 @@ Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code
             </td>
 
             
-
-            
-
-            <td class="description last"><p>container to collect the results. Needs to be created before e.g. using <code>{}</code>.</p></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>filterMatchesFunction</code></td>
-            
-
-            <td class="type">
-            
+                <td class="attributes">
                 
-<span class="param-type">function</span>
-
 
-            
-            </td>
+                
 
+                
+                    &lt;repeatable><br>
+                
+                </td>
             
 
             
 
-            <td class="description last"><p>takes the property name as string argument and returns true (include) or false (exclude).</p></td>
+            <td class="description last"><p>variable count of parameters. Each parameter contains an object that fields should be resolvable for variables.</p></td>
         </tr>
 
     
@@ -573,7 +545,7 @@ Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="templateResolver.js.html">templateResolver.js</a>, <a href="templateResolver.js.html#line156">line 156</a>
+        <a href="templateResolver.js.html">templateResolver.js</a>, <a href="templateResolver.js.html#line65">line 65</a>
     </li></ul></dd>
     
 
@@ -598,6 +570,28 @@ Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code
 
 
 
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>object with resolvable field names and their values.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">object</span>
+
+
+    </dd>
+</dl>
+
+    
 
 
 
@@ -609,7 +603,7 @@ Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code
     
 
     
-    <h4 class="name" id=".getPropertyNameInfos"><span class="type-signature">(protected, static) </span>getPropertyNameInfos<span class="signature">(fullPropertyName)</span><span class="type-signature"> &rarr; {Object}</span></h4>
+    <h4 class="name" id="resolveTemplate"><span class="type-signature"></span>resolveTemplate<span class="signature">(template)</span><span class="type-signature"> &rarr; {string}</span></h4>
     
 
     
@@ -617,7 +611,11 @@ Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code
 
 
 <div class="description">
-    <p>Infos about the full property name including the name of the group (followed by the separator) and the name of the property itself.</p>
+    <p>Resolves the given template.</p>
+<p>The template may contain variables in double curly brackets.
+Supported variables are all properties of this object, e.g. &quot;{{fieldName}}&quot;, &quot;{{displayName}}&quot;, &quot;{{value}}&quot;.
+Since this object may also contains (described) groups of sub objects, they can also be used, e.g. &quot;{{summaries[0].value}}&quot;
+Parts of the index can be inserted by using e.g. &quot;{{index[1]}}&quot;.</p>
 </div>
 
 
@@ -653,13 +651,13 @@ Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code
 
         <tr>
             
-                <td class="name"><code>fullPropertyName</code></td>
+                <td class="name"><code>template</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">String</span>
+<span class="param-type">string</span>
 
 
             
@@ -710,7 +708,7 @@ Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="templateResolver.js.html">templateResolver.js</a>, <a href="templateResolver.js.html#line132">line 132</a>
+        <a href="templateResolver.js.html">templateResolver.js</a>, <a href="templateResolver.js.html#line48">line 48</a>
     </li></ul></dd>
     
 
@@ -739,7 +737,7 @@ Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code
 
         
 <div class="param-desc">
-    <p>Contains &quot;group&quot; (empty or group name including trailing separator &quot;.&quot;), &quot;groupWithoutArrayIndices&quot; and &quot;name&quot; (property name).</p>
+    <p>resolved template</p>
 </div>
 
 
@@ -750,7 +748,7 @@ Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code
     </dt>
     <dd>
         
-<span class="param-type">Object</span>
+<span class="param-type">string</span>
 
 
     </dd>
@@ -768,7 +766,7 @@ Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code
     
 
     
-    <h4 class="name" id="replaceResolvableFields"><span class="type-signature"></span>replaceResolvableFields<span class="signature">(stringContainingVariables, resolvableFields)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id=".addFieldsPerGroup"><span class="type-signature">(protected, static) </span>addFieldsPerGroup<span class="signature">(object)</span><span class="type-signature"> &rarr; {object}</span></h4>
     
 
     
@@ -776,9 +774,8 @@ Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code
 
 
 <div class="description">
-    <p>Replaces all variables in double curly brackets, e.g. {{property}},
-with the value of that property from the resolvableProperties.</p>
-<p>Supported property types: string, number, boolean</p>
+    <p>Adds the value of the &quot;fieldName&quot; property (including its group prefix) and its associated &quot;value&quot; property content.
+For example: detail[2].fieldName=&quot;name&quot;, detail[2].value=&quot;Smith&quot; lead to the additional property detail.name=&quot;Smith&quot;.</p>
 </div>
 
 
@@ -814,36 +811,13 @@ with the value of that property from the resolvableProperties.</p>
 
         <tr>
             
-                <td class="name"><code>stringContainingVariables</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">string</span>
-
-
-            
-            </td>
-
-            
-
-            
-
-            <td class="description last"></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>resolvableFields</code></td>
+                <td class="name"><code>object</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">Array.&lt;object></span>
+<span class="param-type">object</span>
 
 
             
@@ -853,7 +827,7 @@ with the value of that property from the resolvableProperties.</p>
 
             
 
-            <td class="description last"><p>(name=value)</p></td>
+            <td class="description last"><p>with resolvable field names and their values.</p></td>
         </tr>
 
     
@@ -894,7 +868,7 @@ with the value of that property from the resolvableProperties.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="templateResolver.js.html">templateResolver.js</a>, <a href="templateResolver.js.html#line84">line 84</a>
+        <a href="templateResolver.js.html">templateResolver.js</a>, <a href="templateResolver.js.html#line107">line 107</a>
     </li></ul></dd>
     
 
@@ -919,6 +893,28 @@ with the value of that property from the resolvableProperties.</p>
 
 
 
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>object with resolvable field names and their values.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">object</span>
+
+
+    </dd>
+</dl>
+
+    
 
 
 
@@ -930,7 +926,7 @@ with the value of that property from the resolvableProperties.</p>
     
 
     
-    <h4 class="name" id="resolvableFieldsOfAll"><span class="type-signature"></span>resolvableFieldsOfAll<span class="signature">(&hellip;varArgs)</span><span class="type-signature"> &rarr; {object}</span></h4>
+    <h4 class="name" id=".addToFilteredMapObject"><span class="type-signature">(protected, static) </span>addToFilteredMapObject<span class="signature">(elements, mapObject, filterMatchesFunction)</span><span class="type-signature"></span></h4>
     
 
     
@@ -938,12 +934,8 @@ with the value of that property from the resolvableProperties.</p>
 
 
 <div class="description">
-    <p>Returns a map like object, that contains all resolvable fields and their values as properties.
-This function takes a variable count of input parameters,
-each containing an object that contains resolvable fields to extract from.</p>
-<p>The recursion depth is limited to 3, so that an object,
-that contains an object can contain another object (but not further).</p>
-<p>Properties beginning with an underscore in their name will be filtered out, since they are considered as internal fields.</p>
+    <p>Collects all flattened name-value-pairs into one object using the property names as keys and their values as values (map-like).
+Example: <code>{name: &quot;accountNumber&quot;, value: &quot;12345&quot;}</code> becomes <code>mapObject[&quot;accountNumber&quot;]=&quot;12345&quot;</code>.</p>
 </div>
 
 
@@ -967,8 +959,6 @@ that contains an object can contain another object (but not further).</p>
         <th>Type</th>
 
         
-        <th>Attributes</th>
-        
 
         
 
@@ -981,33 +971,69 @@ that contains an object can contain another object (but not further).</p>
 
         <tr>
             
-                <td class="name"><code>varArgs</code></td>
+                <td class="name"><code>elements</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">object</span>
+<span class="param-type">Array.&lt;NameValuePair></span>
 
 
             
             </td>
 
             
-                <td class="attributes">
-                
 
-                
+            
+
+            <td class="description last"><p>flattened array of name-value-pairs</p></td>
+        </tr>
 
+    
+
+        <tr>
+            
+                <td class="name"><code>mapObject</code></td>
+            
+
+            <td class="type">
+            
                 
-                    &lt;repeatable><br>
+<span class="param-type">object</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>container to collect the results. Needs to be created before e.g. using <code>{}</code>.</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>filterMatchesFunction</code></td>
+            
+
+            <td class="type">
+            
                 
-                </td>
+<span class="param-type">function</span>
+
+
+            
+            </td>
+
             
 
             
 
-            <td class="description last"><p>variable count of parameters. Each parameter contains an object that fields should be resolvable for variables.</p></td>
+            <td class="description last"><p>takes the property name as string argument and returns true (include) or false (exclude).</p></td>
         </tr>
 
     
@@ -1048,7 +1074,7 @@ that contains an object can contain another object (but not further).</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="templateResolver.js.html">templateResolver.js</a>, <a href="templateResolver.js.html#line65">line 65</a>
+        <a href="templateResolver.js.html">templateResolver.js</a>, <a href="templateResolver.js.html#line156">line 156</a>
     </li></ul></dd>
     
 
@@ -1073,28 +1099,6 @@ that contains an object can contain another object (but not further).</p>
 
 
 
-<h5>Returns:</h5>
-
-        
-<div class="param-desc">
-    <p>object with resolvable field names and their values.</p>
-</div>
-
-
-
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type">object</span>
-
-
-    </dd>
-</dl>
-
-    
 
 
 
@@ -1106,7 +1110,7 @@ that contains an object can contain another object (but not further).</p>
     
 
     
-    <h4 class="name" id="resolveTemplate"><span class="type-signature"></span>resolveTemplate<span class="signature">(template)</span><span class="type-signature"> &rarr; {string}</span></h4>
+    <h4 class="name" id=".getPropertyNameInfos"><span class="type-signature">(protected, static) </span>getPropertyNameInfos<span class="signature">(fullPropertyName)</span><span class="type-signature"> &rarr; {Object}</span></h4>
     
 
     
@@ -1114,11 +1118,7 @@ that contains an object can contain another object (but not further).</p>
 
 
 <div class="description">
-    <p>Resolves the given template.</p>
-<p>The template may contain variables in double curly brackets.
-Supported variables are all properties of this object, e.g. &quot;{{fieldName}}&quot;, &quot;{{displayName}}&quot;, &quot;{{value}}&quot;.
-Since this object may also contains (described) groups of sub objects, they can also be used, e.g. &quot;{{summaries[0].value}}&quot;
-Parts of the index can be inserted by using e.g. &quot;{{index[1]}}&quot;.</p>
+    <p>Infos about the full property name including the name of the group (followed by the separator) and the name of the property itself.</p>
 </div>
 
 
@@ -1154,13 +1154,13 @@ Parts of the index can be inserted by using e.g. &quot;{{index[1]}}&quot;.</p>
 
         <tr>
             
-                <td class="name"><code>template</code></td>
+                <td class="name"><code>fullPropertyName</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">string</span>
+<span class="param-type">String</span>
 
 
             
@@ -1211,7 +1211,7 @@ Parts of the index can be inserted by using e.g. &quot;{{index[1]}}&quot;.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="templateResolver.js.html">templateResolver.js</a>, <a href="templateResolver.js.html#line48">line 48</a>
+        <a href="templateResolver.js.html">templateResolver.js</a>, <a href="templateResolver.js.html#line132">line 132</a>
     </li></ul></dd>
     
 
@@ -1240,7 +1240,7 @@ Parts of the index can be inserted by using e.g. &quot;{{index[1]}}&quot;.</p>
 
         
 <div class="param-desc">
-    <p>resolved template</p>
+    <p>Contains &quot;group&quot; (empty or group name including trailing separator &quot;.&quot;), &quot;groupWithoutArrayIndices&quot; and &quot;name&quot; (property name).</p>
 </div>
 
 
@@ -1251,7 +1251,7 @@ Parts of the index can be inserted by using e.g. &quot;{{index[1]}}&quot;.</p>
     </dt>
     <dd>
         
-<span class="param-type">string</span>
+<span class="param-type">Object</span>
 
 
     </dd>
@@ -1285,7 +1285,7 @@ Parts of the index can be inserted by using e.g. &quot;{{index[1]}}&quot;.</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Oct 31 2022 17:00:02 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Fri Oct 20 2023 21:28:55 GMT+0200 (Central European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>