@bitbeater/ecma-utils 2.7.0

package/dist/utils/task_duration_tracker.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskDurationTracker = void 0;
+const collection_1 = require("../collection/collection");
+const time_1 = require("../time/time");
+/**
+ * @description A utility class to track the duration of multiple tasks and estimate completion times.
+ * - It records the start and end times of each task, calculates elapsed time, estimates remaining time,
+ * - and provides the expected finish time based on the average duration of completed tasks.
+ *
+ * @example
+ * ```ts
+ * // let's assume the date is Jan 1, 2000, 00:00:00
+ * const tracker = new TaskDurationTracker(5); // Initialize tracker for 5 tasks
+ *
+ * for (let i = 0; i < 5; i++) {
+ *   performTask(i); // Lets assume it takes 1 second to perform a task
+ *   tracker.recordTaskEnd(); // Record the end of the task
+ *
+ *   console.log(`Completed ${tracker.getCompletedTasks()} out of ${tracker.tasksCount} tasks.`);
+ *   console.log(`Elapsed Time: ${tracker.getElapsedTime().milliseconds} ms`);
+ *   console.log(`Estimated Completion Time: ${tracker.getEstimatedCompletionTime().milliseconds} ms`);
+ *   console.log(`Expected Finish Time: ${tracker.getExpectedFinishTime()}`);
+ *
+ * }
+ *  // OUTPUT:
+ * // Completed 1 out of 5 tasks.
+ * // Elapsed Time: 1000 ms
+ * // Estimated Completion Time: 4000 ms
+ * // Expected Finish Time: Jan 1, 2000, 00:00:05
+ *
+ * // Completed 2 out of 5 tasks.
+ * // Elapsed Time: 2000 ms
+ * // Estimated Completion Time: 3000 ms
+ * // Expected Finish Time: Jan 1, 2000, 00:00:05
+ *
+ * // Completed 3 out of 5 tasks.
+ * // Elapsed Time: 3000 ms
+ * // Estimated Completion Time: 2000 ms
+ * // Expected Finish Time: Jan 1, 2000, 00:00:05
+ *
+ * // Completed 4 out of 5 tasks.
+ * // Elapsed Time: 4000 ms
+ * // Estimated Completion Time: 1000 ms
+ * // Expected Finish Time: Jan 1, 2000, 00:00:05
+ *
+ * // Completed 5 out of 5 tasks.
+ * // Elapsed Time: 5000 ms
+ * // Estimated Completion Time: 0 ms
+ * // Expected Finish Time: Jan 1, 2000, 00:00:05
+ * ```
+ *
+ * @see {@link Duration}
+ * @see {@link Interval}
+ */
+class TaskDurationTracker {
+    constructor(tasksCount) {
+        this.tasksCount = tasksCount;
+        this.intervals = [];
+        this.creationTime = new Date();
+    }
+    /**
+     * @description Gets the total elapsed time since the first task started.
+     * @returns the total elapsed time since the first task started.
+     */
+    getElapsedTime() {
+        const milliseconds = new Date().getTime() - this.getStartTime().getTime();
+        return (0, time_1.millisecondsToDuration)(milliseconds);
+    }
+    /**
+     * @description Estimates the total time taken to complete all tasks.
+     */
+    getEstimatedCompletionTime() {
+        const meanTime = this.getMeanTimePerTask();
+        const remainingTasks = this.getRemainingTasks();
+        const remainingMillis = (0, time_1.durationToMilliSeconds)(meanTime) * remainingTasks;
+        return (0, time_1.millisecondsToDuration)(remainingMillis);
+    }
+    /**
+     * @description Gets the expected finish time for all tasks.
+     */
+    getExpectedFinishTime() {
+        const remainingMillis = (0, time_1.durationToMilliSeconds)(this.getEstimatedCompletionTime());
+        return new Date(Date.now() + remainingMillis);
+    }
+    /**
+     * @description Gets the number of completed tasks.
+     * @returns the number of completed tasks.
+     */
+    getCompletedTasks() {
+        return this.intervals.length;
+    }
+    /**
+     * @description Gets the number of remaining tasks.
+     * @returns the number of remaining tasks.
+     */
+    getRemainingTasks() {
+        return Math.max(this.tasksCount - this.intervals.length, 0);
+    }
+    /**
+     * @description Gets the mean time taken per task.
+     * @returns the mean time taken per task.
+     */
+    getMeanTimePerTask() {
+        if (this.intervals.length === 0) {
+            return this.getElapsedTime();
+        }
+        const totalMillis = this.intervals.reduce((acc, interval) => {
+            if (interval.start && interval.end) {
+                return acc + (interval.end.getTime() - interval.start.getTime());
+            }
+            return acc;
+        }, 0);
+        const meanMillis = totalMillis / this.intervals.length;
+        return (0, time_1.millisecondsToDuration)(Math.round(meanMillis));
+    }
+    /**
+     * @description Adds a task interval to the tracker.
+     * @param interval The interval of the task to add.
+     */
+    addCompletedTask(interval) {
+        this.intervals.push(interval);
+    }
+    /**
+     * @description Gets the start time of the first task, or the creation time if no tasks have been started.
+     * @returns the start time of the first task, or the creation time if no tasks have been started.
+     */
+    getStartTime() {
+        return this.intervals[0]?.start || this.creationTime;
+    }
+    /**
+     * @description Marks the current task as completed,
+     * - the start time is either the end time of the last task or the TaskDurationTracker creation time,
+     * - the end time is the current time.
+     */
+    recordTaskEnd() {
+        this.intervals.push({
+            start: (0, collection_1.lastEl)(this.intervals)?.end || this.creationTime,
+            end: new Date(),
+        });
+    }
+}
+exports.TaskDurationTracker = TaskDurationTracker;
+//# sourceMappingURL=task_duration_tracker.js.map

package/dist/utils/task_duration_tracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"task_duration_tracker.js","sourceRoot":"","sources":["../../src/utils/task_duration_tracker.ts"],"names":[],"mappings":";;;AAAA,yDAAkD;AAClD,uCAAkG;AAElG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAa,mBAAmB;IAI/B,YAAmB,UAAkB;QAAlB,eAAU,GAAV,UAAU,CAAQ;QAH7B,cAAS,GAAe,EAAE,CAAC;QAC3B,iBAAY,GAAG,IAAI,IAAI,EAAE,CAAC;IAEM,CAAC;IAEzC;;;OAGG;IACH,cAAc;QACb,MAAM,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,OAAO,EAAE,CAAC;QAC1E,OAAO,IAAA,6BAAsB,EAAC,YAAY,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,0BAA0B;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC3C,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAChD,MAAM,eAAe,GAAG,IAAA,6BAAsB,EAAC,QAAQ,CAAC,GAAG,cAAc,CAAC;QAC1E,OAAO,IAAA,6BAAsB,EAAC,eAAe,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,qBAAqB;QACpB,MAAM,eAAe,GAAG,IAAA,6BAAsB,EAAC,IAAI,CAAC,0BAA0B,EAAE,CAAC,CAAC;QAClF,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,eAAe,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,iBAAiB;QAChB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,iBAAiB;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACH,kBAAkB;QACjB,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;QAC9B,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE;YAC3D,IAAI,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,GAAG,EAAE,CAAC;gBACpC,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAClE,CAAC;YACD,OAAO,GAAG,CAAC;QACZ,CAAC,EAAE,CAAC,CAAC,CAAC;QACN,MAAM,UAAU,GAAG,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;QACvD,OAAO,IAAA,6BAAsB,EAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,QAAkB;QAClC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,YAAY;QACX,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACH,aAAa;QACZ,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YACnB,KAAK,EAAE,IAAA,mBAAM,EAAC,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,IAAI,IAAI,CAAC,YAAY;YACvD,GAAG,EAAE,IAAI,IAAI,EAAE;SACf,CAAC,CAAC;IACJ,CAAC;CACD;AA/FD,kDA+FC"}

package/dist/utils/utils.d.ts

@@ -0,0 +1,24 @@
+export { TaskDurationTracker } from './task_duration_tracker';
+/**
+ * @description Executes a function a specified number of times and collects the results in an array.
+ * @example
+ * ```ts
+ * const results = forEach(5, i => i * 2);
+ * console.log(results); // [0, 2, 4, 6, 8]
+ * ```
+ * @param execs number of executions
+ * @param fn function to be executed
+ */
+export declare function forEach<T>(execs: number, fn: (i: number) => T): T[];
+/**
+ *
+ * @description A simple utility that benchmarks a function execution,
+ *
+ * @returns an object with min, max and mean time execution, in millis.
+ */
+export declare function benchmarkFn(fn: Function, iterations?: number): {
+    min: number;
+    max: number;
+    mean: number;
+};
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAE9D;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,EAAE,CAInE;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,QAAQ,EAAE,UAAU,SAAI,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAmBpG"}

package/dist/utils/utils.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskDurationTracker = void 0;
+exports.forEach = forEach;
+exports.benchmarkFn = benchmarkFn;
+const collectionOperations_1 = require("../collection/collectionOperations");
+var task_duration_tracker_1 = require("./task_duration_tracker");
+Object.defineProperty(exports, "TaskDurationTracker", { enumerable: true, get: function () { return task_duration_tracker_1.TaskDurationTracker; } });
+/**
+ * @description Executes a function a specified number of times and collects the results in an array.
+ * @example
+ * ```ts
+ * const results = forEach(5, i => i * 2);
+ * console.log(results); // [0, 2, 4, 6, 8]
+ * ```
+ * @param execs number of executions
+ * @param fn function to be executed
+ */
+function forEach(execs, fn) {
+    const results = [];
+    for (var i = 0; execs; i++, execs--)
+        results.push(fn(i));
+    return results;
+}
+/**
+ *
+ * @description A simple utility that benchmarks a function execution,
+ *
+ * @returns an object with min, max and mean time execution, in millis.
+ */
+function benchmarkFn(fn, iterations = 1) {
+    const execTimes = [];
+    var _iterations = iterations + 1;
+    while (--_iterations) {
+        const start = Date.now();
+        fn();
+        const end = Date.now();
+        //execTimes[_iterations] = end - start;
+        execTimes.push(end - start);
+    }
+    const orderedExecTimes = execTimes.sort();
+    const min = orderedExecTimes[0];
+    const max = (0, collectionOperations_1.lastEl)(orderedExecTimes);
+    const mean = execTimes.reduce((pre, cur) => pre + cur, 0) / execTimes.length;
+    return { min, max, mean };
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils/utils.ts"],"names":[],"mappings":";;;AAaA,0BAIC;AAQD,kCAmBC;AA5CD,6EAA4D;AAC5D,iEAA8D;AAArD,4HAAA,mBAAmB,OAAA;AAE5B;;;;;;;;;GASG;AACH,SAAgB,OAAO,CAAI,KAAa,EAAE,EAAoB;IAC7D,MAAM,OAAO,GAAQ,EAAE,CAAC;IACxB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE;QAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,OAAO,OAAO,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,EAAY,EAAE,UAAU,GAAG,CAAC;IACvD,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,IAAI,WAAW,GAAG,UAAU,GAAG,CAAC,CAAC;IAEjC,OAAO,EAAE,WAAW,EAAE,CAAC;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,EAAE,EAAE,CAAC;QACL,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,uCAAuC;QACvC,SAAS,CAAC,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,gBAAgB,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;IAC1C,MAAM,GAAG,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAChC,MAAM,GAAG,GAAG,IAAA,6BAAM,EAAC,gBAAgB,CAAC,CAAC;IACrC,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC;IAE7E,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC"}

package/package.json

@@ -0,0 +1,68 @@
+{
+	"name": "@bitbeater/ecma-utils",
+	"version": "2.7.0",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"sideEffects": false,
+	"exports": {
+		".": {
+			"default": "./dist/index.js"
+		},
+		"./collection": {
+			"default": "./dist/collection/collection.js"
+		},
+		"./bytes": {
+			"default": "./dist/bytes.js"
+		},
+		"./http": {
+			"default": "./dist/net/http.js"
+		},
+		"./utils": {
+			"default": "./dist/utils/utils.js"
+		},
+		"./time": {
+			"default": "./dist/time/time.js"
+		},
+		"./*": {
+			"default": "./dist/*.js"
+		}
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc",
+		"genDocs": "npx typedoc --options typedoc.json",
+		"prettify": "prettier --config ./.prettierrc.json --write \"src/**/*.ts\"",
+		"test": "tsc && node --test -r ./node_modules/ts-node/register/transpile-only.js ./tests/{**/*,*}.test.ts"
+	},
+	"author": "",
+	"license": "ISC",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/bitBeater/ecma-utils.git"
+	},
+	"bugs": {
+		"url": "https://github.com/bitBeater/ecma-utils/issues"
+	},
+	"homepage": "https://github.com/bitBeater/ecma-utils#readme",
+	"description": "",
+	"typesVersions": {
+		"*": {
+			"*": [
+				"dist/*",
+				"dist/*/index.d.ts"
+			]
+		}
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"devDependencies": {
+		"@types/node": "^24.3.0",
+		"prettier": "^3.7.4",
+		"ts-node": "^10.9.1",
+		"typedoc": "^0.28.11",
+		"typescript": "^5.9.2"
+	}
+}