@universal-packages/time-measurer 1.0.0

package/Measurement.d.ts

@@ -0,0 +1,16 @@
+import { TimeFormat } from './Measurement.types';
+export default class Measurement {
+    readonly hours: number;
+    readonly minutes: number;
+    readonly seconds: number;
+    readonly milliseconds: number;
+    constructor(nanoseconds: bigint);
+    /** Returns the measured time in a formated string */
+    toString(format?: TimeFormat): string;
+    /** Returns the measured time in a formated string */
+    toDate(): Date;
+    private getCondenced;
+    private getHuman;
+    private gerExpressive;
+    private pad;
+}

package/Measurement.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Measurement {
+    constructor(nanoseconds) {
+        let currentNanoseconds = nanoseconds;
+        this.hours = Number(currentNanoseconds / 3600000000000n);
+        currentNanoseconds = currentNanoseconds - BigInt(Math.floor(this.hours)) * 3600000000000n;
+        this.minutes = Number(currentNanoseconds / 60000000000n);
+        currentNanoseconds = currentNanoseconds - BigInt(Math.floor(this.minutes)) * 60000000000n;
+        this.seconds = Number(currentNanoseconds / 1000000000n);
+        currentNanoseconds = currentNanoseconds - BigInt(Math.floor(this.seconds)) * 1000000000n;
+        this.milliseconds = Number(currentNanoseconds) / 1000000;
+    }
+    /** Returns the measured time in a formated string */
+    toString(format = 'Human') {
+        switch (format) {
+            case 'Condensed':
+                return this.getCondenced();
+            case 'Human':
+                return this.getHuman();
+            case 'Expressive':
+                return this.gerExpressive();
+        }
+    }
+    /** Returns the measured time in a formated string */
+    toDate() {
+        return new Date(0, 0, 0, this.hours, this.minutes, this.seconds, this.milliseconds);
+    }
+    getCondenced() {
+        if (this.hours !== 0) {
+            return `${this.pad(this.hours)}:${this.pad(this.minutes)}:${this.pad(this.seconds)}.${this.pad(this.milliseconds, 3)}`;
+        }
+        else if (this.minutes !== 0) {
+            return `${this.pad(this.minutes)}:${this.pad(this.seconds)}.${this.pad(this.milliseconds, 3)}`;
+        }
+        else if (this.seconds !== 0) {
+            return `${this.seconds}.${this.pad(this.milliseconds, 3)}`;
+        }
+        else {
+            return `${this.pad(this.milliseconds, 3, 2)}`;
+        }
+    }
+    getHuman() {
+        if (this.hours !== 0) {
+            return `${this.pad(this.hours)}hrs ${this.pad(this.minutes)}min ${this.pad(this.seconds)}.${this.pad(this.milliseconds, 3)}sec`;
+        }
+        else if (this.minutes !== 0) {
+            return `${this.pad(this.minutes)}min ${this.pad(this.seconds)}.${this.pad(this.milliseconds, 3)}sec`;
+        }
+        else if (this.seconds !== 0) {
+            return `${this.pad(this.seconds)}.${this.pad(this.milliseconds, 3)}sec`;
+        }
+        else {
+            return `${this.pad(this.milliseconds, 3, 2)}ms`;
+        }
+    }
+    gerExpressive() {
+        if (this.hours !== 0) {
+            return `${this.pad(this.hours)} Hours, ${this.pad(this.minutes)} Minutes, and ${this.pad(this.seconds)}.${this.pad(this.milliseconds, 3)} Seconds`;
+        }
+        else if (this.minutes !== 0) {
+            return `${this.pad(this.minutes)} Minutes, and ${this.pad(this.seconds)}.${this.pad(this.milliseconds, 3)} Seconds`;
+        }
+        else if (this.seconds !== 0) {
+            return `${this.pad(this.seconds)}.${this.pad(this.milliseconds, 3)} Seconds`;
+        }
+        else {
+            return `${this.pad(this.milliseconds, 3, 2)} Milliseconds`;
+        }
+    }
+    pad(num, places = 2, fixPositions = 0) {
+        return num.toFixed(fixPositions).padStart(places, '0');
+    }
+}
+exports.default = Measurement;
+//# sourceMappingURL=Measurement.js.map

package/Measurement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Measurement.js","sourceRoot":"","sources":["../src/Measurement.ts"],"names":[],"mappings":";;AAEA,MAAqB,WAAW;IAM9B,YAAmB,WAAmB;QACpC,IAAI,kBAAkB,GAAG,WAAW,CAAA;QAEpC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,kBAAkB,GAAG,cAAc,CAAC,CAAA;QACxD,kBAAkB,GAAG,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,cAAc,CAAA;QAEzF,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,kBAAkB,GAAG,YAAY,CAAC,CAAA;QACxD,kBAAkB,GAAG,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,YAAY,CAAA;QAEzF,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,kBAAkB,GAAG,WAAW,CAAC,CAAA;QACvD,kBAAkB,GAAG,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,WAAW,CAAA;QAExF,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAA;IAC1D,CAAC;IAED,qDAAqD;IAC9C,QAAQ,CAAC,SAAqB,OAAO;QAC1C,QAAQ,MAAM,EAAE;YACd,KAAK,WAAW;gBACd,OAAO,IAAI,CAAC,YAAY,EAAE,CAAA;YAC5B,KAAK,OAAO;gBACV,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAA;YACxB,KAAK,YAAY;gBACf,OAAO,IAAI,CAAC,aAAa,EAAE,CAAA;SAC9B;IACH,CAAC;IAED,qDAAqD;IAC9C,MAAM;QACX,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAA;IACrF,CAAC;IAEO,YAAY;QAClB,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE;YACpB,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,CAAA;SACvH;aAAM,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE;YAC7B,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,CAAA;SAC/F;aAAM,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE;YAC7B,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,CAAA;SAC3D;aAAM;YACL,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAA;SAC9C;IACH,CAAC;IAEO,QAAQ;QACd,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE;YACpB,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,KAAK,CAAA;SAChI;aAAM,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE;YAC7B,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,KAAK,CAAA;SACrG;aAAM,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE;YAC7B,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,KAAK,CAAA;SACxE;aAAM;YACL,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAA;SAChD;IACH,CAAC;IAEO,aAAa;QACnB,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE;YACpB,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,UAAU,CAAA;SACnJ;aAAM,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE;YAC7B,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,UAAU,CAAA;SACpH;aAAM,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE;YAC7B,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,UAAU,CAAA;SAC7E;aAAM;YACL,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC,eAAe,CAAA;SAC3D;IACH,CAAC;IAEO,GAAG,CAAC,GAAW,EAAE,MAAM,GAAG,CAAC,EAAE,YAAY,GAAG,CAAC;QACnD,OAAO,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACxD,CAAC;CACF;AA7ED,8BA6EC"}

package/Measurement.types.d.ts

@@ -0,0 +1 @@
+export declare type TimeFormat = 'Expressive' | 'Human' | 'Condensed';

package/Measurement.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Measurement.types.js.map

package/Measurement.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Measurement.types.js","sourceRoot":"","sources":["../src/Measurement.types.ts"],"names":[],"mappings":""}

package/TimeMeasurer.d.ts

@@ -0,0 +1,27 @@
+import Measurement from './Measurement';
+/**
+ *
+ * It meassures the time a process takes from the time start is called
+ * to when the finish method is called
+ *
+ */
+export default class TimeMeasurer {
+    private hrstart;
+    /** Starts a measurement */
+    start(): void;
+    /** Returns a measurement representing the time passed from when start wass colled */
+    finish(): Measurement;
+    /**
+     * Simple waitable timeout to sleep the process
+     *
+     * Example:
+     *
+     * ```ts
+     * // In milliseconds
+     * await TimeMeasurer.sleep(1000)
+     *
+     * ```
+     *
+     * */
+    static sleep(time: number): Promise<void>;
+}

package/TimeMeasurer.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Measurement_1 = __importDefault(require("./Measurement"));
+const sleep_1 = __importDefault(require("./sleep"));
+/**
+ *
+ * It meassures the time a process takes from the time start is called
+ * to when the finish method is called
+ *
+ */
+class TimeMeasurer {
+    /** Starts a measurement */
+    start() {
+        this.hrstart = process.hrtime.bigint();
+    }
+    /** Returns a measurement representing the time passed from when start wass colled */
+    finish() {
+        if (this.hrstart === undefined)
+            throw new Error('Time measurer finished without previously started');
+        const nanoseconds = process.hrtime.bigint() - this.hrstart;
+        return new Measurement_1.default(nanoseconds);
+    }
+    /**
+     * Simple waitable timeout to sleep the process
+     *
+     * Example:
+     *
+     * ```ts
+     * // In milliseconds
+     * await TimeMeasurer.sleep(1000)
+     *
+     * ```
+     *
+     * */
+    static async sleep(time) {
+        return (0, sleep_1.default)(time);
+    }
+}
+exports.default = TimeMeasurer;
+//# sourceMappingURL=TimeMeasurer.js.map

package/TimeMeasurer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimeMeasurer.js","sourceRoot":"","sources":["../src/TimeMeasurer.ts"],"names":[],"mappings":";;;;;AAAA,gEAAuC;AACvC,oDAA2B;AAE3B;;;;;GAKG;AACH,MAAqB,YAAY;IAG/B,2BAA2B;IACpB,KAAK;QACV,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAA;IACxC,CAAC;IAED,qFAAqF;IAC9E,MAAM;QACX,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;QAEpG,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAE1D,OAAO,IAAI,qBAAW,CAAC,WAAW,CAAC,CAAA;IACrC,CAAC;IAED;;;;;;;;;;;SAWK;IACE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAY;QACpC,OAAO,IAAA,eAAK,EAAC,IAAI,CAAC,CAAA;IACpB,CAAC;CACF;AAhCD,+BAgCC"}

package/index.d.ts

@@ -0,0 +1,5 @@
+export { default } from './TimeMeasurer';
+export { default as Measurement } from './Measurement';
+export * from './Measurement.types';
+export { default as sleep } from './sleep';
+export * from './singleton';

package/index.js

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sleep = exports.Measurement = exports.default = void 0;
+var TimeMeasurer_1 = require("./TimeMeasurer");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(TimeMeasurer_1).default; } });
+var Measurement_1 = require("./Measurement");
+Object.defineProperty(exports, "Measurement", { enumerable: true, get: function () { return __importDefault(Measurement_1).default; } });
+__exportStar(require("./Measurement.types"), exports);
+var sleep_1 = require("./sleep");
+Object.defineProperty(exports, "sleep", { enumerable: true, get: function () { return __importDefault(sleep_1).default; } });
+__exportStar(require("./singleton"), exports);
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,+CAAwC;AAA/B,wHAAA,OAAO,OAAA;AAChB,6CAAsD;AAA7C,2HAAA,OAAO,OAAe;AAC/B,sDAAmC;AACnC,iCAA0C;AAAjC,+GAAA,OAAO,OAAS;AACzB,8CAA2B"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@universal-packages/time-measurer",
+  "version": "1.0.0",
+  "description": "Utility to measure routines times with precision",
+  "author": "David De Anda <david@universal-packages.com> (https://github.com/universal-packages)",
+  "license": "MIT",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "repository": "git://git@github.com/universal-packeges/universal-time-measurer.git",
+  "scripts": {
+    "build": "tsc --p tsconfig.dis.json",
+    "test": "jest --watch",
+    "test:full": "jest --coverage --verbose"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@types/jest": "^28.1.0",
+    "@types/node": "^17.0.39",
+    "jest": "^28.1.0",
+    "jest-circus": "^28.1.0",
+    "ts-jest": "^28.0.4",
+    "typescript": "^4.7.3"
+  },
+  "jest": {
+    "testRunner": "jest-circus/runner",
+    "transform": {
+      "^.+\\.(ts|tsx)$": "ts-jest"
+    },
+    "testRegex": "(/tests/.*\\.test\\.ts?)$",
+    "collectCoverageFrom": [
+      "src/**/*.ts"
+    ],
+    "setupFilesAfterEnv": [
+      "<rootDir>/tests/setupTests.ts"
+    ],
+    "watchPathIgnorePatterns": [
+      "<rootDir>/tmp"
+    ]
+  },
+  "prettier": {
+    "semi": false,
+    "singleQuote": true,
+    "printWidth": 180,
+    "trailingComma": "none"
+  }
+}

package/singleton.d.ts

@@ -0,0 +1,3 @@
+import Measurement from './Measurement';
+export declare function start(): void;
+export declare function finish(): Measurement;

package/singleton.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.finish = exports.start = void 0;
+const TimeMeasurer_1 = __importDefault(require("./TimeMeasurer"));
+const PROCESS_MEASURER = new TimeMeasurer_1.default();
+function start() {
+    PROCESS_MEASURER.start();
+}
+exports.start = start;
+function finish() {
+    return PROCESS_MEASURER.finish();
+}
+exports.finish = finish;
+//# sourceMappingURL=singleton.js.map

package/singleton.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"singleton.js","sourceRoot":"","sources":["../src/singleton.ts"],"names":[],"mappings":";;;;;;AACA,kEAAyC;AAEzC,MAAM,gBAAgB,GAAG,IAAI,sBAAY,EAAE,CAAA;AAE3C,SAAgB,KAAK;IACnB,gBAAgB,CAAC,KAAK,EAAE,CAAA;AAC1B,CAAC;AAFD,sBAEC;AAED,SAAgB,MAAM;IACpB,OAAO,gBAAgB,CAAC,MAAM,EAAE,CAAA;AAClC,CAAC;AAFD,wBAEC"}

package/sleep.d.ts

@@ -0,0 +1 @@
+export default function sleep(time: number): Promise<void>;

package/sleep.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+async function sleep(time) {
+    return new Promise((resolve) => setTimeout(() => resolve(), time));
+}
+exports.default = sleep;
+//# sourceMappingURL=sleep.js.map

package/sleep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sleep.js","sourceRoot":"","sources":["../src/sleep.ts"],"names":[],"mappings":";;AAAe,KAAK,UAAU,KAAK,CAAC,IAAY;IAC9C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAkB,EAAE,CAAC,UAAU,CAAC,GAAS,EAAE,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC,CAAA;AAC1F,CAAC;AAFD,wBAEC"}