@velony/utils 1.0.0 → 1.0.2

package/dist/time.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Error thrown when a time string format is invalid.
+ *
+ * @example
+ * throw new InvalidTimeStringError('Invalid format: "2x"');
+ */
+export declare class InvalidTimeStringError extends Error {
+    constructor(message?: string);
+}
+/**
+ * Checks if a given string is a valid time format.
+ * Supports compound inputs like "1h30m15s500ms".
+ *
+ * @param input - The time string to validate.
+ * @returns `true` if the input is valid, otherwise `false`.
+ *
+ * @example
+ * isTimeString("1h30m");        // true
+ * isTimeString("2x");           // false
+ * isTimeString("500ms");        // true
+ * isTimeString("2d3h15m30s");   // true
+ * isTimeString("");             // false
+ */
+export declare const isTimeString: (input: string) => boolean;
+/**
+ * Converts a valid time string into multiple time units.
+ * Supports compound inputs such as "1h30m15s500ms".
+ *
+ * @param input - The time string to convert (e.g., `"1h30m"`, `"500ms"`, `"2d3h"`).
+ * @returns An object containing equivalent durations in seconds, milliseconds, minutes, hours, days, and weeks.
+ * @throws {@link InvalidTimeStringError} If the input format is invalid.
+ *
+ * @example
+ * convertTime("1h30m");
+ * // Returns:
+ * // {
+ * //   seconds: 5400,
+ * //   milliseconds: 5400000,
+ * //   minutes: 90,
+ * //   hours: 1.5,
+ * //   days: 0.0625,
+ * //   weeks: 0.008928571428571428
+ * // }
+ *
+ * @example
+ * convertTime("500ms");
+ * // Returns: { seconds: 0.5, milliseconds: 500, ... }
+ */
+export declare const convertTime: (input: string) => {
+    seconds: number;
+    milliseconds: number;
+    minutes: number;
+    hours: number;
+    days: number;
+    weeks: number;
+};

package/dist/time.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertTime = exports.isTimeString = exports.InvalidTimeStringError = void 0;
+/**
+ * Error thrown when a time string format is invalid.
+ *
+ * @example
+ * throw new InvalidTimeStringError('Invalid format: "2x"');
+ */
+class InvalidTimeStringError extends Error {
+    constructor(message = 'Invalid time string format') {
+        super(message);
+        this.name = 'InvalidTimeStringError';
+    }
+}
+exports.InvalidTimeStringError = InvalidTimeStringError;
+/**
+ * List of valid time units supported by the converter.
+ */
+const VALID_UNITS = ['ms', 's', 'm', 'h', 'd', 'w'];
+/**
+ * Checks if a given string is a valid time format.
+ * Supports compound inputs like "1h30m15s500ms".
+ *
+ * @param input - The time string to validate.
+ * @returns `true` if the input is valid, otherwise `false`.
+ *
+ * @example
+ * isTimeString("1h30m");        // true
+ * isTimeString("2x");           // false
+ * isTimeString("500ms");        // true
+ * isTimeString("2d3h15m30s");   // true
+ * isTimeString("");             // false
+ */
+const isTimeString = (input) => {
+    if (typeof input !== 'string' || !input.trim()) {
+        return false;
+    }
+    const regex = /(\d+)([a-z]+)/g;
+    let match;
+    let found = false;
+    while ((match = regex.exec(input)) !== null) {
+        found = true;
+        const unit = match[2];
+        if (!VALID_UNITS.includes(unit)) {
+            return false;
+        }
+    }
+    return found;
+};
+exports.isTimeString = isTimeString;
+/**
+ * Converts a valid time string into multiple time units.
+ * Supports compound inputs such as "1h30m15s500ms".
+ *
+ * @param input - The time string to convert (e.g., `"1h30m"`, `"500ms"`, `"2d3h"`).
+ * @returns An object containing equivalent durations in seconds, milliseconds, minutes, hours, days, and weeks.
+ * @throws {@link InvalidTimeStringError} If the input format is invalid.
+ *
+ * @example
+ * convertTime("1h30m");
+ * // Returns:
+ * // {
+ * //   seconds: 5400,
+ * //   milliseconds: 5400000,
+ * //   minutes: 90,
+ * //   hours: 1.5,
+ * //   days: 0.0625,
+ * //   weeks: 0.008928571428571428
+ * // }
+ *
+ * @example
+ * convertTime("500ms");
+ * // Returns: { seconds: 0.5, milliseconds: 500, ... }
+ */
+const convertTime = (input) => {
+    if (!(0, exports.isTimeString)(input)) {
+        throw new InvalidTimeStringError();
+    }
+    const units = {
+        ms: 1 / 1000,
+        s: 1,
+        m: 60,
+        h: 3600,
+        d: 86400,
+        w: 604800,
+    };
+    const regex = /(\d+)(ms|s|m|h|d|w)/g;
+    let match;
+    let totalSeconds = 0;
+    while ((match = regex.exec(input)) !== null) {
+        const value = parseInt(match[1]);
+        const unit = match[2];
+        // eslint-disable-next-line security/detect-object-injection
+        const multiplier = units[unit];
+        totalSeconds += value * multiplier;
+    }
+    return {
+        seconds: totalSeconds,
+        milliseconds: totalSeconds * 1000,
+        minutes: totalSeconds / 60,
+        hours: totalSeconds / 3600,
+        days: totalSeconds / 86400,
+        weeks: totalSeconds / 604800,
+    };
+};
+exports.convertTime = convertTime;
+//# sourceMappingURL=time.js.map

package/dist/time.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"time.js","sourceRoot":"","sources":["../src/time.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,MAAa,sBAAuB,SAAQ,KAAK;IAC/C,YAAY,OAAO,GAAG,4BAA4B;QAChD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;IACvC,CAAC;CACF;AALD,wDAKC;AAED;;GAEG;AACH,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAU,CAAC;AAG7D;;;;;;;;;;;;;GAaG;AACI,MAAM,YAAY,GAAG,CAAC,KAAa,EAAW,EAAE;IACrD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;QAC/C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,KAAK,GAAG,gBAAgB,CAAC;IAC/B,IAAI,KAA6B,CAAC;IAClC,IAAI,KAAK,GAAG,KAAK,CAAC;IAElB,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QAC5C,KAAK,GAAG,IAAI,CAAC;QACb,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAgB,CAAC,EAAE,CAAC;YAC5C,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAlBW,QAAA,YAAY,gBAkBvB;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,MAAM,WAAW,GAAG,CACzB,KAAa,EAQb,EAAE;IACF,IAAI,CAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,sBAAsB,EAAE,CAAC;IACrC,CAAC;IAED,MAAM,KAAK,GAA6B;QACtC,EAAE,EAAE,CAAC,GAAG,IAAI;QACZ,CAAC,EAAE,CAAC;QACJ,CAAC,EAAE,EAAE;QACL,CAAC,EAAE,IAAI;QACP,CAAC,EAAE,KAAK;QACR,CAAC,EAAE,MAAM;KACV,CAAC;IAEF,MAAM,KAAK,GAAG,sBAAsB,CAAC;IACrC,IAAI,KAA6B,CAAC;IAClC,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAa,CAAC;QAElC,4DAA4D;QAC5D,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,YAAY,IAAI,KAAK,GAAG,UAAU,CAAC;IACrC,CAAC;IAED,OAAO;QACL,OAAO,EAAE,YAAY;QACrB,YAAY,EAAE,YAAY,GAAG,IAAI;QACjC,OAAO,EAAE,YAAY,GAAG,EAAE;QAC1B,KAAK,EAAE,YAAY,GAAG,IAAI;QAC1B,IAAI,EAAE,YAAY,GAAG,KAAK;QAC1B,KAAK,EAAE,YAAY,GAAG,MAAM;KAC7B,CAAC;AACJ,CAAC,CAAC;AA5CW,QAAA,WAAW,eA4CtB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@velony/utils",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "TypeScript utility library providing common helper functions for time conversion and formatting",
   "keywords": [
     "utils",