@tmlmobilidade/timer 20251202.1817.5

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Timer class for tracking elapsed time.
+ * Provides methods to get formatted time strings and raw time values.
+ */
+declare class TimerClass {
+    private startTime;
+    constructor();
+    /**
+     * Gets the elapsed time as a formatted string.
+     * @param reset - If true, resets the timer after getting the elapsed time
+     * @returns Formatted string (e.g., "1h 2m 3s 456ms" or "0ms")
+     */
+    get(reset?: boolean): string;
+    /**
+     * Gets the elapsed time in milliseconds.
+     * @param reset - If true, resets the timer after getting the elapsed time
+     * @returns Elapsed time in milliseconds
+     */
+    getMs(reset?: boolean): number;
+    /**
+     * Gets the elapsed time in seconds.
+     * @param reset - If true, resets the timer after getting the elapsed time
+     * @returns Elapsed time in seconds (with decimal precision)
+     */
+    getSeconds(reset?: boolean): number;
+    /**
+     * Resets the timer to the current time.
+     */
+    reset(): void;
+    /**
+     * Formats elapsed time in milliseconds to a human-readable string.
+     * @param elapsedTime - Time in milliseconds
+     * @returns Formatted string (e.g., "1h 2m 3s 456ms" or "0ms")
+     */
+    private formatElapsedTime;
+}
+/**
+ * Singleton Timer instance for tracking time.
+ * @example
+ * ```ts
+ * Timer.reset();
+ * // ... do work ...
+ * console.log(Timer.get()); // "1s 234ms"
+ * ```
+ */
+export { TimerClass as Timer };

package/dist/index.js

@@ -0,0 +1,88 @@
+/**
+ * Timer class for tracking elapsed time.
+ * Provides methods to get formatted time strings and raw time values.
+ */
+class TimerClass {
+    startTime;
+    constructor() {
+        this.startTime = Date.now();
+    }
+    /**
+     * Gets the elapsed time as a formatted string.
+     * @param reset - If true, resets the timer after getting the elapsed time
+     * @returns Formatted string (e.g., "1h 2m 3s 456ms" or "0ms")
+     */
+    get(reset = false) {
+        const elapsedTime = Date.now() - this.startTime;
+        const result = this.formatElapsedTime(elapsedTime);
+        if (reset) {
+            this.reset();
+        }
+        return result;
+    }
+    /**
+     * Gets the elapsed time in milliseconds.
+     * @param reset - If true, resets the timer after getting the elapsed time
+     * @returns Elapsed time in milliseconds
+     */
+    getMs(reset = false) {
+        const elapsedTime = Date.now() - this.startTime;
+        if (reset) {
+            this.reset();
+        }
+        return elapsedTime;
+    }
+    /**
+     * Gets the elapsed time in seconds.
+     * @param reset - If true, resets the timer after getting the elapsed time
+     * @returns Elapsed time in seconds (with decimal precision)
+     */
+    getSeconds(reset = false) {
+        const elapsedTime = Date.now() - this.startTime;
+        const seconds = elapsedTime / 1000;
+        if (reset) {
+            this.reset();
+        }
+        return seconds;
+    }
+    /**
+     * Resets the timer to the current time.
+     */
+    reset() {
+        this.startTime = Date.now();
+    }
+    /**
+     * Formats elapsed time in milliseconds to a human-readable string.
+     * @param elapsedTime - Time in milliseconds
+     * @returns Formatted string (e.g., "1h 2m 3s 456ms" or "0ms")
+     */
+    formatElapsedTime(elapsedTime) {
+        // Ensure non-negative time
+        const time = Math.max(0, elapsedTime);
+        const hours = Math.floor(time / (1000 * 60 * 60));
+        const minutes = Math.floor(time / (1000 * 60)) % 60;
+        const seconds = Math.floor(time / 1000) % 60;
+        const milliseconds = time % 1000;
+        const parts = [];
+        if (hours > 0)
+            parts.push(`${hours}h`);
+        if (minutes > 0)
+            parts.push(`${minutes}m`);
+        if (seconds > 0)
+            parts.push(`${seconds}s`);
+        if (milliseconds > 0 || parts.length === 0) {
+            parts.push(`${milliseconds}ms`);
+        }
+        return parts.join(' ');
+    }
+}
+/**
+ * Singleton Timer instance for tracking time.
+ * @example
+ * ```ts
+ * Timer.reset();
+ * // ... do work ...
+ * console.log(Timer.get()); // "1s 234ms"
+ * ```
+ */
+export { TimerClass as Timer };

package/package.json

@@ -0,0 +1,45 @@
+{
+	"name": "@tmlmobilidade/timer",
+	"version": "20251202.1817.5",
+	"author": {
+		"email": "iso@tmlmobilidade.pt",
+		"name": "TML-ISO"
+	},
+	"license": "AGPL-3.0-or-later",
+	"homepage": "https://github.com/tmlmobilidade/go#readme",
+	"bugs": {
+		"url": "https://github.com/tmlmobilidade/go/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/tmlmobilidade/go.git"
+	},
+	"keywords": [
+		"public transit",
+		"tml",
+		"transportes metropolitanos de lisboa",
+		"go"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"files": [
+		"dist"
+	],
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"scripts": {
+		"build": "tsc && resolve-tspaths",
+		"lint": "eslint ./src/ && tsc --noEmit",
+		"lint:fix": "eslint ./src/ --fix",
+		"watch": "tsc-watch --onSuccess 'resolve-tspaths'"
+	},
+	"devDependencies": {
+		"@tmlmobilidade/tsconfig": "*",
+		"@types/node": "24.10.1",
+		"resolve-tspaths": "0.8.23",
+		"tsc-watch": "7.2.0",
+		"typescript": "5.9.3"
+	}
+}