topkat-utils 1.2.112 → 1.2.116

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.
@@ -0,0 +1,232 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for math-utils.ts</title>
7
+ <meta charset="utf-8" />
8
+ <link rel="stylesheet" href="prettify.css" />
9
+ <link rel="stylesheet" href="base.css" />
10
+ <link rel="shortcut icon" type="image/x-icon" href="favicon.png" />
11
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
12
+ <style type='text/css'>
13
+ .coverage-summary .sorter {
14
+ background-image: url(sort-arrow-sprite.png);
15
+ }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <div class='wrapper'>
21
+ <div class='pad1'>
22
+ <h1><a href="index.html">All files</a> math-utils.ts</h1>
23
+ <div class='clearfix'>
24
+
25
+ <div class='fl pad1y space-right2'>
26
+ <span class="strong">58% </span>
27
+ <span class="quiet">Statements</span>
28
+ <span class='fraction'>29/50</span>
29
+ </div>
30
+
31
+
32
+ <div class='fl pad1y space-right2'>
33
+ <span class="strong">100% </span>
34
+ <span class="quiet">Branches</span>
35
+ <span class='fraction'>0/0</span>
36
+ </div>
37
+
38
+
39
+ <div class='fl pad1y space-right2'>
40
+ <span class="strong">0% </span>
41
+ <span class="quiet">Functions</span>
42
+ <span class='fraction'>0/9</span>
43
+ </div>
44
+
45
+
46
+ <div class='fl pad1y space-right2'>
47
+ <span class="strong">58% </span>
48
+ <span class="quiet">Lines</span>
49
+ <span class='fraction'>29/50</span>
50
+ </div>
51
+
52
+
53
+ </div>
54
+ <p class="quiet">
55
+ Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
+ </p>
57
+ <template id="filterTemplate">
58
+ <div class="quiet">
59
+ Filter:
60
+ <input type="search" id="fileSearch">
61
+ </div>
62
+ </template>
63
+ </div>
64
+ <div class='status-line medium'></div>
65
+ <pre><table class="coverage">
66
+ <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
+ <a name='L2'></a><a href='#L2'>2</a>
68
+ <a name='L3'></a><a href='#L3'>3</a>
69
+ <a name='L4'></a><a href='#L4'>4</a>
70
+ <a name='L5'></a><a href='#L5'>5</a>
71
+ <a name='L6'></a><a href='#L6'>6</a>
72
+ <a name='L7'></a><a href='#L7'>7</a>
73
+ <a name='L8'></a><a href='#L8'>8</a>
74
+ <a name='L9'></a><a href='#L9'>9</a>
75
+ <a name='L10'></a><a href='#L10'>10</a>
76
+ <a name='L11'></a><a href='#L11'>11</a>
77
+ <a name='L12'></a><a href='#L12'>12</a>
78
+ <a name='L13'></a><a href='#L13'>13</a>
79
+ <a name='L14'></a><a href='#L14'>14</a>
80
+ <a name='L15'></a><a href='#L15'>15</a>
81
+ <a name='L16'></a><a href='#L16'>16</a>
82
+ <a name='L17'></a><a href='#L17'>17</a>
83
+ <a name='L18'></a><a href='#L18'>18</a>
84
+ <a name='L19'></a><a href='#L19'>19</a>
85
+ <a name='L20'></a><a href='#L20'>20</a>
86
+ <a name='L21'></a><a href='#L21'>21</a>
87
+ <a name='L22'></a><a href='#L22'>22</a>
88
+ <a name='L23'></a><a href='#L23'>23</a>
89
+ <a name='L24'></a><a href='#L24'>24</a>
90
+ <a name='L25'></a><a href='#L25'>25</a>
91
+ <a name='L26'></a><a href='#L26'>26</a>
92
+ <a name='L27'></a><a href='#L27'>27</a>
93
+ <a name='L28'></a><a href='#L28'>28</a>
94
+ <a name='L29'></a><a href='#L29'>29</a>
95
+ <a name='L30'></a><a href='#L30'>30</a>
96
+ <a name='L31'></a><a href='#L31'>31</a>
97
+ <a name='L32'></a><a href='#L32'>32</a>
98
+ <a name='L33'></a><a href='#L33'>33</a>
99
+ <a name='L34'></a><a href='#L34'>34</a>
100
+ <a name='L35'></a><a href='#L35'>35</a>
101
+ <a name='L36'></a><a href='#L36'>36</a>
102
+ <a name='L37'></a><a href='#L37'>37</a>
103
+ <a name='L38'></a><a href='#L38'>38</a>
104
+ <a name='L39'></a><a href='#L39'>39</a>
105
+ <a name='L40'></a><a href='#L40'>40</a>
106
+ <a name='L41'></a><a href='#L41'>41</a>
107
+ <a name='L42'></a><a href='#L42'>42</a>
108
+ <a name='L43'></a><a href='#L43'>43</a>
109
+ <a name='L44'></a><a href='#L44'>44</a>
110
+ <a name='L45'></a><a href='#L45'>45</a>
111
+ <a name='L46'></a><a href='#L46'>46</a>
112
+ <a name='L47'></a><a href='#L47'>47</a>
113
+ <a name='L48'></a><a href='#L48'>48</a>
114
+ <a name='L49'></a><a href='#L49'>49</a>
115
+ <a name='L50'></a><a href='#L50'>50</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">2x</span>
116
+ <span class="cline-any cline-yes">2x</span>
117
+ <span class="cline-any cline-yes">2x</span>
118
+ <span class="cline-any cline-yes">2x</span>
119
+ <span class="cline-any cline-yes">2x</span>
120
+ <span class="cline-any cline-yes">2x</span>
121
+ <span class="cline-any cline-no">&nbsp;</span>
122
+ <span class="cline-any cline-yes">2x</span>
123
+ <span class="cline-any cline-no">&nbsp;</span>
124
+ <span class="cline-any cline-yes">2x</span>
125
+ <span class="cline-any cline-yes">2x</span>
126
+ <span class="cline-any cline-no">&nbsp;</span>
127
+ <span class="cline-any cline-yes">2x</span>
128
+ <span class="cline-any cline-yes">2x</span>
129
+ <span class="cline-any cline-no">&nbsp;</span>
130
+ <span class="cline-any cline-yes">2x</span>
131
+ <span class="cline-any cline-yes">2x</span>
132
+ <span class="cline-any cline-no">&nbsp;</span>
133
+ <span class="cline-any cline-no">&nbsp;</span>
134
+ <span class="cline-any cline-no">&nbsp;</span>
135
+ <span class="cline-any cline-no">&nbsp;</span>
136
+ <span class="cline-any cline-no">&nbsp;</span>
137
+ <span class="cline-any cline-no">&nbsp;</span>
138
+ <span class="cline-any cline-no">&nbsp;</span>
139
+ <span class="cline-any cline-no">&nbsp;</span>
140
+ <span class="cline-any cline-no">&nbsp;</span>
141
+ <span class="cline-any cline-yes">2x</span>
142
+ <span class="cline-any cline-yes">2x</span>
143
+ <span class="cline-any cline-no">&nbsp;</span>
144
+ <span class="cline-any cline-no">&nbsp;</span>
145
+ <span class="cline-any cline-no">&nbsp;</span>
146
+ <span class="cline-any cline-yes">2x</span>
147
+ <span class="cline-any cline-yes">2x</span>
148
+ <span class="cline-any cline-yes">2x</span>
149
+ <span class="cline-any cline-yes">2x</span>
150
+ <span class="cline-any cline-no">&nbsp;</span>
151
+ <span class="cline-any cline-no">&nbsp;</span>
152
+ <span class="cline-any cline-no">&nbsp;</span>
153
+ <span class="cline-any cline-yes">2x</span>
154
+ <span class="cline-any cline-yes">2x</span>
155
+ <span class="cline-any cline-no">&nbsp;</span>
156
+ <span class="cline-any cline-yes">2x</span>
157
+ <span class="cline-any cline-yes">2x</span>
158
+ <span class="cline-any cline-yes">2x</span>
159
+ <span class="cline-any cline-yes">2x</span>
160
+ <span class="cline-any cline-yes">2x</span>
161
+ <span class="cline-any cline-yes">2x</span>
162
+ <span class="cline-any cline-yes">2x</span>
163
+ <span class="cline-any cline-yes">2x</span>
164
+ <span class="cline-any cline-no">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">//----------------------------------------
165
+ // MATH UTILS
166
+ //----------------------------------------
167
+ import { isset } from './isset'
168
+ &nbsp;
169
+ /** Round with custom number of decimals (default:0) */
170
+ <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >export function round(number: number | string, decimals = 0) { return Math.round((typeof number === 'number' ? number : parseFloat(number)) * Math.pow(10, decimals)) / Math.pow(10, decimals) }</span></span>
171
+ /** Round with custom number of decimals (default:2) */
172
+ <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >export function round2(number: number | string, decimals = 2) { return round(number, decimals) }</span></span>
173
+ &nbsp;
174
+ /** Is number between two numbers (including those numbers) */
175
+ <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >export function isBetween(number: number, min: number, max: number, inclusive = true) { return inclusive ? number &lt;= max &amp;&amp; number &gt;= min : number &lt; max &amp;&amp; number &gt; min }</span></span>
176
+ &nbsp;
177
+ /** Random number between two values with 0 decimals by default */
178
+ <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >export function random(nb1: number, nb2: number, nbOfDecimals = 0) { return round(Math.random() * (nb2 - nb1) + nb1, nbOfDecimals) }</span></span>
179
+ &nbsp;
180
+ /** Random multiple of a number between two values */
181
+ <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >export function randomMultipleOf(multiple: number, nb1: number, nb2: number) {</span></span>
182
+ <span class="cstat-no" title="statement not covered" ></span>
183
+ <span class="cstat-no" title="statement not covered" > if (multiple === 0) multiple = 1</span>
184
+ <span class="cstat-no" title="statement not covered" ></span>
185
+ <span class="cstat-no" title="statement not covered" > let randomNumber = Math.random() * (nb2 - nb1) + nb1</span>
186
+ <span class="cstat-no" title="statement not covered" > randomNumber = Math.round(randomNumber / multiple) * multiple</span>
187
+ <span class="cstat-no" title="statement not covered" ></span>
188
+ <span class="cstat-no" title="statement not covered" > return randomNumber &lt; 1 ? randomNumber = multiple : randomNumber</span>
189
+ <span class="cstat-no" title="statement not covered" >}</span>
190
+ &nbsp;
191
+ /** Sum all values of an array, all values MUST be numbers */
192
+ <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >export function sumArray(array: number[]) {</span></span>
193
+ <span class="cstat-no" title="statement not covered" > return array.filter(item =&gt; typeof item === 'number').reduce((sum, val) =&gt; isset(val) ? val + sum : sum, 0)</span>
194
+ <span class="cstat-no" title="statement not covered" >}</span>
195
+ &nbsp;
196
+ /** Moyenne / average between array of values
197
+ * @param {Number} round number of decimals to keep. Default:2
198
+ */
199
+ <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >export function moyenne(array: number[], nbOfDecimals = 2) {</span></span>
200
+ <span class="cstat-no" title="statement not covered" > return round(sumArray(array) / array.length, nbOfDecimals)</span>
201
+ <span class="cstat-no" title="statement not covered" >}</span>
202
+ &nbsp;
203
+ /** length default 2, shortcut for 1 to 01 */
204
+ <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >export function pad(numberOrStr: number | string, length = 2) { return ('' + numberOrStr).padStart(length, '0') }</span></span>
205
+ &nbsp;
206
+ &nbsp;
207
+ /** return the number or the closest number of the range
208
+ * * nb min max =&gt; returns
209
+ * * 7 5 10 =&gt; 7 // in the range
210
+ * * 2 5 10 =&gt; 5 // below the min value
211
+ * * 99 5 10 =&gt; 10// above the max value
212
+ */
213
+ <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >export function minMax(nb: number, min: number, max: number) { return Math.max(min, Math.min(nb, max)) }</span></span></pre></td></tr></table></pre>
214
+
215
+ <div class='push'></div><!-- for sticky footer -->
216
+ </div><!-- /wrapper -->
217
+ <div class='footer quiet pad2 space-top1 center small'>
218
+ Code coverage generated by
219
+ <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
220
+ at 2025-03-13T18:42:56.377Z
221
+ </div>
222
+ <script src="prettify.js"></script>
223
+ <script>
224
+ window.onload = function () {
225
+ prettyPrint();
226
+ };
227
+ </script>
228
+ <script src="sorter.js"></script>
229
+ <script src="block-navigation.js"></script>
230
+ </body>
231
+ </html>
232
+
@@ -1387,7 +1387,7 @@ export const entries = objEntries</pre></td></tr></table></pre>
1387
1387
  <div class='footer quiet pad2 space-top1 center small'>
1388
1388
  Code coverage generated by
1389
1389
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
1390
- at 2025-03-09T16:53:29.189Z
1390
+ at 2025-03-13T18:42:56.377Z
1391
1391
  </div>
1392
1392
  <script src="prettify.js"></script>
1393
1393
  <script>
@@ -190,7 +190,7 @@ import { C } from './logger-utils'
190
190
  <div class='footer quiet pad2 space-top1 center small'>
191
191
  Code coverage generated by
192
192
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
193
- at 2025-03-09T16:53:29.189Z
193
+ at 2025-03-13T18:42:56.377Z
194
194
  </div>
195
195
  <script src="prettify.js"></script>
196
196
  <script>
@@ -124,7 +124,7 @@
124
124
  <div class='footer quiet pad2 space-top1 center small'>
125
125
  Code coverage generated by
126
126
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
127
- at 2025-03-09T16:53:29.189Z
127
+ at 2025-03-13T18:42:56.377Z
128
128
  </div>
129
129
  <script src="prettify.js"></script>
130
130
  <script>
@@ -907,7 +907,7 @@ export type MiniTemplaterOptions = {
907
907
  <div class='footer quiet pad2 space-top1 center small'>
908
908
  Code coverage generated by
909
909
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
910
- at 2025-03-09T16:53:29.189Z
910
+ at 2025-03-13T18:42:56.377Z
911
911
  </div>
912
912
  <script src="prettify.js"></script>
913
913
  <script>
@@ -23,9 +23,9 @@
23
23
  <div class='clearfix'>
24
24
 
25
25
  <div class='fl pad1y space-right2'>
26
- <span class="strong">49.27% </span>
26
+ <span class="strong">50.56% </span>
27
27
  <span class="quiet">Statements</span>
28
- <span class='fraction'>34/69</span>
28
+ <span class='fraction'>45/89</span>
29
29
  </div>
30
30
 
31
31
 
@@ -37,16 +37,16 @@
37
37
 
38
38
 
39
39
  <div class='fl pad1y space-right2'>
40
- <span class="strong">33.33% </span>
40
+ <span class="strong">28.57% </span>
41
41
  <span class="quiet">Functions</span>
42
- <span class='fraction'>2/6</span>
42
+ <span class='fraction'>2/7</span>
43
43
  </div>
44
44
 
45
45
 
46
46
  <div class='fl pad1y space-right2'>
47
- <span class="strong">49.27% </span>
47
+ <span class="strong">50.56% </span>
48
48
  <span class="quiet">Lines</span>
49
- <span class='fraction'>34/69</span>
49
+ <span class='fraction'>45/89</span>
50
50
  </div>
51
51
 
52
52
 
@@ -61,7 +61,7 @@
61
61
  </div>
62
62
  </template>
63
63
  </div>
64
- <div class='status-line low'></div>
64
+ <div class='status-line medium'></div>
65
65
  <pre><table class="coverage">
66
66
  <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
67
  <a name='L2'></a><a href='#L2'>2</a>
@@ -131,7 +131,28 @@
131
131
  <a name='L66'></a><a href='#L66'>66</a>
132
132
  <a name='L67'></a><a href='#L67'>67</a>
133
133
  <a name='L68'></a><a href='#L68'>68</a>
134
- <a name='L69'></a><a href='#L69'>69</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">2x</span>
134
+ <a name='L69'></a><a href='#L69'>69</a>
135
+ <a name='L70'></a><a href='#L70'>70</a>
136
+ <a name='L71'></a><a href='#L71'>71</a>
137
+ <a name='L72'></a><a href='#L72'>72</a>
138
+ <a name='L73'></a><a href='#L73'>73</a>
139
+ <a name='L74'></a><a href='#L74'>74</a>
140
+ <a name='L75'></a><a href='#L75'>75</a>
141
+ <a name='L76'></a><a href='#L76'>76</a>
142
+ <a name='L77'></a><a href='#L77'>77</a>
143
+ <a name='L78'></a><a href='#L78'>78</a>
144
+ <a name='L79'></a><a href='#L79'>79</a>
145
+ <a name='L80'></a><a href='#L80'>80</a>
146
+ <a name='L81'></a><a href='#L81'>81</a>
147
+ <a name='L82'></a><a href='#L82'>82</a>
148
+ <a name='L83'></a><a href='#L83'>83</a>
149
+ <a name='L84'></a><a href='#L84'>84</a>
150
+ <a name='L85'></a><a href='#L85'>85</a>
151
+ <a name='L86'></a><a href='#L86'>86</a>
152
+ <a name='L87'></a><a href='#L87'>87</a>
153
+ <a name='L88'></a><a href='#L88'>88</a>
154
+ <a name='L89'></a><a href='#L89'>89</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">2x</span>
155
+ <span class="cline-any cline-yes">2x</span>
135
156
  <span class="cline-any cline-yes">2x</span>
136
157
  <span class="cline-any cline-yes">2x</span>
137
158
  <span class="cline-any cline-yes">2x</span>
@@ -199,12 +220,32 @@
199
220
  <span class="cline-any cline-no">&nbsp;</span>
200
221
  <span class="cline-any cline-no">&nbsp;</span>
201
222
  <span class="cline-any cline-no">&nbsp;</span>
223
+ <span class="cline-any cline-no">&nbsp;</span>
224
+ <span class="cline-any cline-yes">2x</span>
225
+ <span class="cline-any cline-yes">2x</span>
226
+ <span class="cline-any cline-yes">2x</span>
227
+ <span class="cline-any cline-yes">2x</span>
228
+ <span class="cline-any cline-yes">2x</span>
229
+ <span class="cline-any cline-yes">2x</span>
230
+ <span class="cline-any cline-yes">2x</span>
231
+ <span class="cline-any cline-yes">2x</span>
232
+ <span class="cline-any cline-yes">2x</span>
233
+ <span class="cline-any cline-yes">2x</span>
234
+ <span class="cline-any cline-no">&nbsp;</span>
235
+ <span class="cline-any cline-no">&nbsp;</span>
236
+ <span class="cline-any cline-no">&nbsp;</span>
237
+ <span class="cline-any cline-no">&nbsp;</span>
238
+ <span class="cline-any cline-no">&nbsp;</span>
239
+ <span class="cline-any cline-no">&nbsp;</span>
240
+ <span class="cline-any cline-no">&nbsp;</span>
241
+ <span class="cline-any cline-no">&nbsp;</span>
202
242
  <span class="cline-any cline-no">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">&nbsp;
203
243
  //----------------------------------------
204
244
  // TIMEOUT UTILS
205
245
  //----------------------------------------
206
246
  import { cliProgressBar, C } from './logger-utils'
207
247
  import { DescriptiveError } from './error-utils'
248
+ import { round2 } from './math-utils'
208
249
  &nbsp;
209
250
  &nbsp;
210
251
  export async function timeout(ms, fn = () =&gt; { /* */ }) { return new Promise(res =&gt; setTimeout(res, ms)).then(fn) }
@@ -267,6 +308,25 @@ export <span class="fstat-no" title="function not covered" >async function retry
267
308
  <span class="cstat-no" title="statement not covered" > await timeout(n * 1000)</span>
268
309
  <span class="cstat-no" title="statement not covered" > await callback()</span>
269
310
  <span class="cstat-no" title="statement not covered" > }</span>
311
+ <span class="cstat-no" title="statement not covered" >}</span>
312
+ &nbsp;
313
+ /** Use this timer to measure code performances.
314
+ * @example ```
315
+ const time = perfTimer()
316
+ &nbsp;
317
+ for(let i = 0; i &lt; 9999;i++) longProcess()
318
+ &nbsp;
319
+ console.log('Process took ' + time.end())
320
+ ```
321
+ */
322
+ <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >export function perfTimer(unit: 'ms' | 'seconds' = 'seconds') {</span></span>
323
+ <span class="cstat-no" title="statement not covered" > return {</span>
324
+ <span class="cstat-no" title="statement not covered" > start: Date.now(),</span>
325
+ <span class="cstat-no" title="statement not covered" > end() {</span>
326
+ <span class="cstat-no" title="statement not covered" > const msSinceStart = Date.now() - this.start</span>
327
+ <span class="cstat-no" title="statement not covered" > return unit === 'ms' ? msSinceStart + ' ' + unit : round2(msSinceStart / 1000) + ' ' + unit</span>
328
+ <span class="cstat-no" title="statement not covered" > }</span>
329
+ <span class="cstat-no" title="statement not covered" > }</span>
270
330
  <span class="cstat-no" title="statement not covered" >}</span></pre></td></tr></table></pre>
271
331
 
272
332
  <div class='push'></div><!-- for sticky footer -->
@@ -274,7 +334,7 @@ export <span class="fstat-no" title="function not covered" >async function retry
274
334
  <div class='footer quiet pad2 space-top1 center small'>
275
335
  Code coverage generated by
276
336
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
277
- at 2025-03-09T16:53:29.189Z
337
+ at 2025-03-13T18:42:56.377Z
278
338
  </div>
279
339
  <script src="prettify.js"></script>
280
340
  <script>
@@ -259,7 +259,7 @@ export <span class="fstat-no" title="function not covered" >async function waitF
259
259
  <div class='footer quiet pad2 space-top1 center small'>
260
260
  Code coverage generated by
261
261
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
262
- at 2025-03-09T16:53:29.189Z
262
+ at 2025-03-13T18:42:56.377Z
263
263
  </div>
264
264
  <script src="prettify.js"></script>
265
265
  <script>