topkat-utils 1.2.112 → 1.2.115

package/coverage/lcov.info

@@ -1074,6 +1074,83 @@ BRF:0
 BRH:0
 end_of_record
 TN:
+SF:src/math-utils.ts
+FN:7,round
+FN:9,round2
+FN:12,isBetween
+FN:15,random
+FN:18,randomMultipleOf
+FN:29,sumArray
+FN:36,moyenne
+FN:41,pad
+FN:50,minMax
+FNF:9
+FNH:0
+FNDA:0,round
+FNDA:0,round2
+FNDA:0,isBetween
+FNDA:0,random
+FNDA:0,randomMultipleOf
+FNDA:0,sumArray
+FNDA:0,moyenne
+FNDA:0,pad
+FNDA:0,minMax
+DA:1,2
+DA:2,2
+DA:3,2
+DA:4,2
+DA:5,2
+DA:6,2
+DA:7,0
+DA:8,2
+DA:9,0
+DA:10,2
+DA:11,2
+DA:12,0
+DA:13,2
+DA:14,2
+DA:15,0
+DA:16,2
+DA:17,2
+DA:18,0
+DA:19,0
+DA:20,0
+DA:21,0
+DA:22,0
+DA:23,0
+DA:24,0
+DA:25,0
+DA:26,0
+DA:27,2
+DA:28,2
+DA:29,0
+DA:30,0
+DA:31,0
+DA:32,2
+DA:33,2
+DA:34,2
+DA:35,2
+DA:36,0
+DA:37,0
+DA:38,0
+DA:39,2
+DA:40,2
+DA:41,0
+DA:42,2
+DA:43,2
+DA:44,2
+DA:45,2
+DA:46,2
+DA:47,2
+DA:48,2
+DA:49,2
+DA:50,0
+LF:50
+LH:29
+BRF:0
+BRH:0
+end_of_record
+TN:
 SF:src/object-utils.ts
 FN:17,simpleObjectMaskOrSelect
 FN:44,has
@@ -1998,13 +2075,14 @@ BRH:0
 end_of_record
 TN:
 SF:src/timer-utils.ts
-FN:9,timeout
-FN:9,fn
-FN:11,runAsync
-FN:20,waitUntilTrue
-FN:44,executeInDelayedLoop
-FN:61,retryWithDelay
-FNF:6
+FN:10,timeout
+FN:10,fn
+FN:12,runAsync
+FN:21,waitUntilTrue
+FN:45,executeInDelayedLoop
+FN:62,retryWithDelay
+FN:81,perfTimer
+FNF:7
 FNH:2
 FNDA:16,timeout
 FNDA:16,fn
@@ -2012,6 +2090,7 @@ FNDA:0,runAsync
 FNDA:0,waitUntilTrue
 FNDA:0,executeInDelayedLoop
 FNDA:0,retryWithDelay
+FNDA:0,perfTimer
 DA:1,2
 DA:2,2
 DA:3,2
@@ -2032,7 +2111,7 @@ DA:17,2
 DA:18,2
 DA:19,2
 DA:20,2
-DA:21,0
+DA:21,2
 DA:22,0
 DA:23,0
 DA:24,0
@@ -2045,7 +2124,7 @@ DA:30,0
 DA:31,0
 DA:32,0
 DA:33,0
-DA:34,2
+DA:34,0
 DA:35,2
 DA:36,2
 DA:37,2
@@ -2056,7 +2135,7 @@ DA:41,2
 DA:42,2
 DA:43,2
 DA:44,2
-DA:45,0
+DA:45,2
 DA:46,0
 DA:47,0
 DA:48,0
@@ -2070,10 +2149,10 @@ DA:55,0
 DA:56,0
 DA:57,0
 DA:58,0
-DA:59,2
+DA:59,0
 DA:60,2
 DA:61,2
-DA:62,0
+DA:62,2
 DA:63,0
 DA:64,0
 DA:65,0
@@ -2081,11 +2160,31 @@ DA:66,0
 DA:67,0
 DA:68,0
 DA:69,0
-LF:69
-LH:34
-BRDA:9,0,0,16
-BRDA:9,1,0,16
-BRDA:9,2,0,16
+DA:70,0
+DA:71,2
+DA:72,2
+DA:73,2
+DA:74,2
+DA:75,2
+DA:76,2
+DA:77,2
+DA:78,2
+DA:79,2
+DA:80,2
+DA:81,0
+DA:82,0
+DA:83,0
+DA:84,0
+DA:85,0
+DA:86,0
+DA:87,0
+DA:88,0
+DA:89,0
+LF:89
+LH:45
+BRDA:10,0,0,16
+BRDA:10,1,0,16
+BRDA:10,2,0,16
 BRF:3
 BRH:3
 end_of_record

package/dist/src/timer-utils.d.ts

@@ -16,3 +16,16 @@ export declare function waitUntilTrue(callback: any, timeoutSec?: number, errorA
 export declare function executeInDelayedLoop(callback: any, time?: number, errorCallback?: (e: any) => any): Promise<void>;
 /** Will first wait before calling callback every seconds configured in retrySeconds array */
 export declare function retryWithDelay(callback: Function, retrySeconds: number[]): Promise<void>;
+/** Use this timer to measure code performances.
+  * @example ```
+const time = perfTimer()
+
+for(let i = 0; i < 9999;i++) longProcess()
+
+console.log('Process took ' + time.end())
+  ```
+ */
+export declare function perfTimer(unit?: 'ms' | 'seconds'): {
+    start: number;
+    end(): string;
+};

package/dist/src/timer-utils.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.retryWithDelay = exports.executeInDelayedLoop = exports.waitUntilTrue = exports.runAsync = exports.timeout = void 0;
+exports.perfTimer = exports.retryWithDelay = exports.executeInDelayedLoop = exports.waitUntilTrue = exports.runAsync = exports.timeout = void 0;
 //----------------------------------------
 // TIMEOUT UTILS
 //----------------------------------------
 const logger_utils_1 = require("./logger-utils");
 const error_utils_1 = require("./error-utils");
+const math_utils_1 = require("./math-utils");
 async function timeout(ms, fn = () => { }) { return new Promise(res => setTimeout(res, ms)).then(fn); }
 exports.timeout = timeout;
 async function runAsync(callback, milliseconds$ = 1) { return timeout(milliseconds$, callback); }
@@ -67,4 +68,23 @@ async function retryWithDelay(callback, retrySeconds) {
     }
 }
 exports.retryWithDelay = retryWithDelay;
+/** Use this timer to measure code performances.
+  * @example ```
+const time = perfTimer()
+
+for(let i = 0; i < 9999;i++) longProcess()
+
+console.log('Process took ' + time.end())
+  ```
+ */
+function perfTimer(unit = 'seconds') {
+    return {
+        start: Date.now(),
+        end() {
+            const msSinceStart = Date.now() - this.start;
+            return unit === 'ms' ? msSinceStart + ' ' + unit : (0, math_utils_1.round2)(msSinceStart / 1000) + ' ' + unit;
+        }
+    };
+}
+exports.perfTimer = perfTimer;
 //# sourceMappingURL=timer-utils.js.map

package/dist/src/timer-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"timer-utils.js","sourceRoot":"","sources":["../../src/timer-utils.ts"],"names":[],"mappings":";;;AACA,0CAA0C;AAC1C,gBAAgB;AAChB,0CAA0C;AAC1C,iDAAkD;AAClD,+CAAgD;AAGzC,KAAK,UAAU,OAAO,CAAC,EAAE,EAAE,EAAE,GAAG,GAAG,EAAE,GAAS,CAAC,IAAI,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA,CAAC,CAAC;AAAnH,0BAAmH;AAE5G,KAAK,UAAU,QAAQ,CAAC,QAAQ,EAAE,aAAa,GAAG,CAAC,IAAI,OAAO,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAA,CAAC,CAAC;AAAvG,4BAAuG;AAEvG;;;;;;GAMG;AACI,KAAK,UAAU,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,EAAE,EAAE,kBAAkB,GAAG,IAAI,EAAE,SAAS,GAAG,IAAI;IACtG,IAAI,cAAc,GAAG,IAAI,CAAA;IACzB,IAAI,IAAI,GAAG,CAAC,CAAA;IACZ,MAAM,OAAO,GAAG,OAAO,kBAAkB,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,GAAG,kBAAkB,CAAC,CAAC,CAAC,sCAAsC,CAAA;IAElI,IAAI,UAAU;QAAE,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,GAAG,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC,CAAA;IAE3E,OAAO,QAAQ,EAAE,KAAK,IAAI,IAAI,cAAc,EAAE;QAC1C,IAAI,SAAS;YAAE,IAAA,6BAAc,EAAC,IAAI,EAAE,CAAC,CAAA;QACrC,MAAM,OAAO,CAAC,GAAG,CAAC,CAAA;KACrB;IACD,IAAI,SAAS;QAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACzC,IAAI,CAAC,cAAc,IAAI,kBAAkB;QAAE,MAAM,IAAI,8BAAgB,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAA;AACjG,CAAC;AAbD,sCAaC;AAGD,MAAM,iBAAiB,GAAyB,EAAE,CAAA;AAClD,IAAI,WAAW,GAAG,KAAK,CAAA;AAEvB;;;;GAIG;AACI,KAAK,UAAU,oBAAoB,CAAC,QAAQ,EAAE,IAAI,GAAG,GAAG,EAAE,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC,gBAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5F,iBAAiB,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,CAAA;IACvD,IAAI,WAAW;QAAE,OAAM;IACvB,WAAW,GAAG,IAAI,CAAA;IAClB,OAAO,iBAAiB,CAAC,MAAM,EAAE;QAC7B,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,aAAa,CAAC,GAAG,iBAAiB,CAAC,KAAK,EAAS,CAAA;QACxE,IAAI;YACA,MAAM,QAAQ,EAAE,CAAA;YAChB,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;SACtB;QAAC,OAAO,GAAG,EAAE;YACV,aAAa,CAAC,GAAG,CAAC,CAAA;SACrB;KACJ;IACD,WAAW,GAAG,KAAK,CAAA;AACvB,CAAC;AAdD,oDAcC;AAED,6FAA6F;AACtF,KAAK,UAAU,cAAc,CAChC,QAAkB,EAClB,YAAsB;IAEtB,KAAK,MAAM,CAAC,IAAI,YAAY,EAAE;QAC1B,MAAM,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;QACvB,MAAM,QAAQ,EAAE,CAAA;KACnB;AACL,CAAC;AARD,wCAQC"}
+{"version":3,"file":"timer-utils.js","sourceRoot":"","sources":["../../src/timer-utils.ts"],"names":[],"mappings":";;;AACA,0CAA0C;AAC1C,gBAAgB;AAChB,0CAA0C;AAC1C,iDAAkD;AAClD,+CAAgD;AAChD,6CAAqC;AAG9B,KAAK,UAAU,OAAO,CAAC,EAAE,EAAE,EAAE,GAAG,GAAG,EAAE,GAAS,CAAC,IAAI,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA,CAAC,CAAC;AAAnH,0BAAmH;AAE5G,KAAK,UAAU,QAAQ,CAAC,QAAQ,EAAE,aAAa,GAAG,CAAC,IAAI,OAAO,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAA,CAAC,CAAC;AAAvG,4BAAuG;AAEvG;;;;;;GAMG;AACI,KAAK,UAAU,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,EAAE,EAAE,kBAAkB,GAAG,IAAI,EAAE,SAAS,GAAG,IAAI;IACtG,IAAI,cAAc,GAAG,IAAI,CAAA;IACzB,IAAI,IAAI,GAAG,CAAC,CAAA;IACZ,MAAM,OAAO,GAAG,OAAO,kBAAkB,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,GAAG,kBAAkB,CAAC,CAAC,CAAC,sCAAsC,CAAA;IAElI,IAAI,UAAU;QAAE,UAAU,CAAC,GAAG,EAAE,CAAC,cAAc,GAAG,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC,CAAA;IAE3E,OAAO,QAAQ,EAAE,KAAK,IAAI,IAAI,cAAc,EAAE;QAC1C,IAAI,SAAS;YAAE,IAAA,6BAAc,EAAC,IAAI,EAAE,CAAC,CAAA;QACrC,MAAM,OAAO,CAAC,GAAG,CAAC,CAAA;KACrB;IACD,IAAI,SAAS;QAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACzC,IAAI,CAAC,cAAc,IAAI,kBAAkB;QAAE,MAAM,IAAI,8BAAgB,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAA;AACjG,CAAC;AAbD,sCAaC;AAGD,MAAM,iBAAiB,GAAyB,EAAE,CAAA;AAClD,IAAI,WAAW,GAAG,KAAK,CAAA;AAEvB;;;;GAIG;AACI,KAAK,UAAU,oBAAoB,CAAC,QAAQ,EAAE,IAAI,GAAG,GAAG,EAAE,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC,gBAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5F,iBAAiB,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,CAAA;IACvD,IAAI,WAAW;QAAE,OAAM;IACvB,WAAW,GAAG,IAAI,CAAA;IAClB,OAAO,iBAAiB,CAAC,MAAM,EAAE;QAC7B,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,aAAa,CAAC,GAAG,iBAAiB,CAAC,KAAK,EAAS,CAAA;QACxE,IAAI;YACA,MAAM,QAAQ,EAAE,CAAA;YAChB,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;SACtB;QAAC,OAAO,GAAG,EAAE;YACV,aAAa,CAAC,GAAG,CAAC,CAAA;SACrB;KACJ;IACD,WAAW,GAAG,KAAK,CAAA;AACvB,CAAC;AAdD,oDAcC;AAED,6FAA6F;AACtF,KAAK,UAAU,cAAc,CAChC,QAAkB,EAClB,YAAsB;IAEtB,KAAK,MAAM,CAAC,IAAI,YAAY,EAAE;QAC1B,MAAM,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;QACvB,MAAM,QAAQ,EAAE,CAAA;KACnB;AACL,CAAC;AARD,wCAQC;AAED;;;;;;;;GAQG;AACH,SAAgB,SAAS,CAAC,OAAyB,SAAS;IACxD,OAAO;QACH,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE;QACjB,GAAG;YACC,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAA;YAC5C,OAAO,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,YAAY,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,IAAA,mBAAM,EAAC,YAAY,GAAG,IAAI,CAAC,GAAG,GAAG,GAAG,IAAI,CAAA;QAC/F,CAAC;KACJ,CAAA;AACL,CAAC;AARD,8BAQC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "topkat-utils",
-  "version": "1.2.112",
+  "version": "1.2.115",
   "type": "commonjs",
   "types": "index.ts",
   "main": "dist",

package/src/timer-utils.ts

@@ -4,6 +4,7 @@
 //----------------------------------------
 import { cliProgressBar, C } from './logger-utils'
 import { DescriptiveError } from './error-utils'
+import { round2 } from './math-utils'
 
 
 export async function timeout(ms, fn = () => { /* */ }) { return new Promise(res => setTimeout(res, ms)).then(fn) }
@@ -66,4 +67,23 @@ export async function retryWithDelay(
         await timeout(n * 1000)
         await callback()
     }
+}
+
+/** Use this timer to measure code performances.
+  * @example ```
+const time = perfTimer()
+
+for(let i = 0; i < 9999;i++) longProcess()
+
+console.log('Process took ' + time.end())
+  ```
+ */
+export function perfTimer(unit: 'ms' | 'seconds' = 'seconds') {
+    return {
+        start: Date.now(),
+        end() {
+            const msSinceStart = Date.now() - this.start
+            return unit === 'ms' ? msSinceStart + ' ' + unit : round2(msSinceStart / 1000) + ' ' + unit
+        }
+    }
 }