@alwatr/parse-duration 5.4.0 → 5.5.1

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.5.1](https://github.com/Alwatr/nanolib/compare/@alwatr/parse-duration@5.5.0...@alwatr/parse-duration@5.5.1) (2025-03-18)
+
+### Code Refactoring
+
+* **parse-duration:** replace isNumber with toNumber for improved number conversion and enhance error handling ([4d63892](https://github.com/Alwatr/nanolib/commit/4d63892f914cebe73bd1dc1e688c2f4ea5b53de1)) by @alimd
+
+## [5.5.0](https://github.com/Alwatr/nanolib/compare/@alwatr/parse-duration@5.4.0...@alwatr/parse-duration@5.5.0) (2025-03-06)
+
+### Miscellaneous Chores
+
+* update username casing in changelog entries ([9722ac9](https://github.com/Alwatr/nanolib/commit/9722ac9a078438a4e8ebfa5826ea70e0e3a52ca6)) by @
+
+### Dependencies update
+
+* bump the development-dependencies group across 1 directory with 11 updates ([720c395](https://github.com/Alwatr/nanolib/commit/720c3954da55c929fe8fb16957121f4c51fb7f0c)) by @dependabot[bot]
+
 ## [5.4.0](https://github.com/Alwatr/nanolib/compare/@alwatr/parse-duration@1.1.8...@alwatr/parse-duration@5.4.0) (2025-02-18)
 
 ## 5.3.0 (2025-02-03)
@@ -110,7 +126,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ### Miscellaneous Chores
 
-- include LICENSE and LEGAL files to publish ([09f366f](https://github.com/Alwatr/nanolib/commit/09f366f680bfa9fb26acb2cd1ccbc68c5a9e9ad8)) by @AliMD
+- include LICENSE and LEGAL files to publish ([09f366f](https://github.com/Alwatr/nanolib/commit/09f366f680bfa9fb26acb2cd1ccbc68c5a9e9ad8)) by @alimd
 
 ## [1.1.3](https://github.com/Alwatr/nanolib/compare/@alwatr/parse-duration@1.1.2...@alwatr/parse-duration@1.1.3) (2024-10-11)
 
@@ -130,7 +146,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ### Features
 
-- **parse-duration:** update parseDuration function to accept duration as number or string ([af413f5](https://github.com/Alwatr/nanolib/commit/af413f5399b7bb8c01d4e14ae1f9238e44368184)) by @AliMD
+- **parse-duration:** update parseDuration function to accept duration as number or string ([af413f5](https://github.com/Alwatr/nanolib/commit/af413f5399b7bb8c01d4e14ae1f9238e44368184)) by @alimd
 - use `package-tracer` ([cc3c5f9](https://github.com/Alwatr/nanolib/commit/cc3c5f9c1a3d03f0d81b46835665f16a0426fd0d)) by @mohammadhonarvar
 
 ### Bug Fixes
@@ -140,7 +156,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 ### Miscellaneous Chores
 
 - **parse-duration:** change the license to AGPL-3.0 ([896df6f](https://github.com/Alwatr/nanolib/commit/896df6f64bb1df5954d6c46694e18bfb3e944f22)) by @ArmanAsadian
-- Update build and lint scripts ([392d0b7](https://github.com/Alwatr/nanolib/commit/392d0b71f446bce336b0256119a80f07aff794ba)) by @AliMD
+- Update build and lint scripts ([392d0b7](https://github.com/Alwatr/nanolib/commit/392d0b71f446bce336b0256119a80f07aff794ba)) by @alimd
 
 ### Dependencies update
 
@@ -155,7 +171,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 ### Dependencies update
 
 - bump the development-dependencies group across 1 directory with 10 updates ([9ed98ff](https://github.com/Alwatr/nanolib/commit/9ed98ffd0668d5a36e255c82edab3af53bffda8f)) by @dependabot[bot]
-- update ([c36ed50](https://github.com/Alwatr/nanolib/commit/c36ed50f68da2f5608ccd96119963a16cfacb4ce)) by @AliMD
+- update ([c36ed50](https://github.com/Alwatr/nanolib/commit/c36ed50f68da2f5608ccd96119963a16cfacb4ce)) by @alimd
 
 ## [1.0.9](https://github.com/Alwatr/nanolib/compare/@alwatr/parse-duration@1.0.8...@alwatr/parse-duration@1.0.9) (2024-08-31)
 
@@ -167,7 +183,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ### Dependencies update
 
-- update all dependencies ([1e0c30e](https://github.com/Alwatr/nanolib/commit/1e0c30e6a3a8e19deb5185814e24ab6c08dca573)) by @AliMD
+- update all dependencies ([1e0c30e](https://github.com/Alwatr/nanolib/commit/1e0c30e6a3a8e19deb5185814e24ab6c08dca573)) by @alimd
 
 ## [1.0.7](https://github.com/Alwatr/nanolib/compare/@alwatr/parse-duration@1.0.6...@alwatr/parse-duration@1.0.7) (2024-07-04)
 
@@ -179,7 +195,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ### Dependencies update
 
-- upgrade ([6dbd300](https://github.com/Alwatr/nanolib/commit/6dbd300642c9bcc9e7d0b281e244bf1b06eb1c38)) by @AliMD
+- upgrade ([6dbd300](https://github.com/Alwatr/nanolib/commit/6dbd300642c9bcc9e7d0b281e244bf1b06eb1c38)) by @alimd
 
 ## [1.0.5](https://github.com/Alwatr/nanolib/compare/@alwatr/parse-duration@1.0.4...@alwatr/parse-duration@1.0.5) (2024-04-25)
 
@@ -193,7 +209,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ### Miscellaneous Chores
 
-- **deps:** update ([1a45030](https://github.com/Alwatr/nanolib/commit/1a450305440b710a300787d4ca24b1ed8c6a39d7)) by @AliMD
+- **deps:** update ([1a45030](https://github.com/Alwatr/nanolib/commit/1a450305440b710a300787d4ca24b1ed8c6a39d7)) by @alimd
 
 ## [1.0.2](https://github.com/Alwatr/nanolib/compare/@alwatr/parse-duration@1.0.1...@alwatr/parse-duration@1.0.2) (2024-01-24)
 
@@ -211,6 +227,6 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ### Features
 
-- **parse-duration:** rewrite module 🤦🏻 ([be62163](https://github.com/Alwatr/nanolib/commit/be6216345cb3d4458307f55b8ae44f5ac60dda89)) by @AliMD
+- **parse-duration:** rewrite module 🤦🏻 ([be62163](https://github.com/Alwatr/nanolib/commit/be6216345cb3d4458307f55b8ae44f5ac60dda89)) by @alimd
 - **parse-duration:** rewrite with document ([43ffecc](https://github.com/Alwatr/nanolib/commit/43ffeccbc4a859ad838938a63fd52c82654cc9bb)) by @njfamirm
 - **parse-duration:** seperate parseDuration from `@alwatr/math` ([f5e32d0](https://github.com/Alwatr/nanolib/commit/f5e32d080be1b5355463f77a2f23fbd0955b8b67)) by @adltalab

package/README.md

@@ -1,48 +1,103 @@
 # Parse-duration
 
-A simple utility to parse a duration string into milliseconds number.
+A simple, efficient utility to parse time duration strings into milliseconds or other time units.
 
 ## Installation
 
 ```bash
+npm install @alwatr/parse-duration
+# or
 yarn add @alwatr/parse-duration
+# or
+pnpm add @alwatr/parse-duration
 ```
 
+## Features
+
+- Parse duration strings (like '10s', '5m', '2h') into milliseconds
+- Convert between different time units
+- TypeScript support with full type safety
+- Zero dependencies (except for internal Alwatr utilities)
+- Optimized for performance
+- Comprehensive error handling
+
 ## Usage
 
 ```js
 import {parseDuration} from '@alwatr/parse-duration';
 
-parseDuration('10s'); // 10,000
-parseDuration('10m'); // 600,000
-parseDuration('10h'); // 36,000,000
-parseDuration('10d'); // 864,000,000
-parseDuration('10w'); // 6,048,000,000
-parseDuration('10M'); // 25,920,000,000
-parseDuration('10y'); // 315,360,000,000
-parseDuration('10d', 'h'); // 240
+// Basic usage - parse to milliseconds
+parseDuration('10s');    // 10,000 (10 seconds in milliseconds)
+parseDuration('5m');     // 300,000 (5 minutes in milliseconds)
+parseDuration('2h');     // 7,200,000 (2 hours in milliseconds)
+parseDuration('1.5d');   // 129,600,000 (1.5 days in milliseconds)
+
+// Accept milliseconds as input
+parseDuration(5000);     // 5,000 (pass through)
+
+// Convert to different units
+parseDuration('10d', 'h');  // 240 (10 days in hours)
+parseDuration('1h', 'm');   // 60 (1 hour in minutes)
+parseDuration('120s', 'm'); // 2 (120 seconds in minutes)
+parseDuration(3600000, 'h'); // 1 (3600000 milliseconds in hours)
 ```
 
-### Unit Table
+## API
+
+### parseDuration(duration, toUnit?)
+
+Parse a duration string or millisecond number into the specified unit (or milliseconds by default).
+
+#### Parameters
+
+- `duration`: `string | number` - A duration string (like '10s', '5m') or a number (treated as milliseconds)
+- `toUnit`: `DurationUnit` (optional) - The unit to convert to. If omitted, returns milliseconds.
+
+#### Returns
 
-| Unit | Description |
-| ---- | ----------- |
-| `s`  | Second      |
-| `m`  | Minute      |
-| `h`  | Hour        |
-| `d`  | Day         |
-| `w`  | Week        |
-| `M`  | Month       |
-| `y`  | Year        |
+- `number`: The duration in the specified unit (or milliseconds if no unit specified)
+
+#### Throws
+
+- `Error('not_a_number')`: If the duration string doesn't contain a valid number
+- `Error('invalid_unit')`: If the unit is not recognized
+- `Error('invalid_format')`: If the duration format is invalid
+
+### Supported Units
+
+| Unit | Description | Milliseconds Equivalent |
+|------|-------------|-------------------------|
+| `s`  | Second      | 1,000                   |
+| `m`  | Minute      | 60,000                  |
+| `h`  | Hour        | 3,600,000               |
+| `d`  | Day         | 86,400,000              |
+| `w`  | Week        | 604,800,000             |
+| `M`  | Month (30d) | 2,592,000,000           |
+| `y`  | Year (365d) | 31,536,000,000          |
+
+## TypeScript Support
+
+```typescript
+import {parseDuration, DurationUnit, Duration} from '@alwatr/parse-duration';
+
+// Type-safe unit parameter
+function waitFor(time: Duration): Promise<void> {
+  const ms = parseDuration(time);
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+// Usage
+await waitFor('5s');
+```
 
 ## Sponsors
 
 The following companies, organizations, and individuals support Nanolib ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
 
-### Contributing
+## Contributing
 
 Contributions are welcome! Please read our [contribution guidelines](https://github.com/Alwatr/.github/blob/next/CONTRIBUTING.md) before submitting a pull request.
 
-### License
+## License
 
 This project is licensed under the [AGPL-3.0 License](LICENSE).

package/dist/main.cjs

@@ -1,4 +1,4 @@
-/* @alwatr/parse-duration v5.4.0 */
+/* @alwatr/parse-duration v5.5.1 */
 "use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -26,8 +26,8 @@ __export(main_exports, {
 module.exports = __toCommonJS(main_exports);
 var import_is_number = require("@alwatr/is-number");
 var import_package_tracer = require("@alwatr/package-tracer");
-__dev_mode__: import_package_tracer.packageTracer.add("@alwatr/parse-duration", "5.4.0");
-var unitConversion_ = {
+__dev_mode__: import_package_tracer.packageTracer.add("@alwatr/parse-duration", "5.5.1");
+var unitConversion = /* @__PURE__ */ Object.freeze({
   s: 1e3,
   m: 6e4,
   h: 36e5,
@@ -35,30 +35,32 @@ var unitConversion_ = {
   w: 6048e5,
   M: 2592e6,
   y: 31536e6
-};
+});
 var parseDuration = (duration, toUnit) => {
   let ms;
   if (typeof duration === "number") {
     ms = duration;
   } else {
-    const durationNumberStr = duration.slice(0, duration.length - 1);
-    if (!(0, import_is_number.isNumber)(durationNumberStr)) {
-      throw new Error(`not_a_number`);
+    if (duration.length < 2) {
+      throw new Error("invalid_format", { cause: { duration } });
     }
-    const durationNumber = +durationNumberStr;
     const durationUnit = duration.slice(-1);
-    const unitConversionFactor = unitConversion_[durationUnit];
+    const unitConversionFactor = unitConversion[durationUnit];
     if (unitConversionFactor === void 0) {
-      throw new Error(`invalid_unit`, { cause: { duration } });
+      throw new Error("invalid_unit", { cause: { durationUnit } });
+    }
+    const durationNumber = (0, import_is_number.toNumber)(duration.slice(0, -1));
+    if (durationNumber === null) {
+      throw new Error("not_a_number", { cause: { duration } });
     }
     ms = durationNumber * unitConversionFactor;
   }
   if (toUnit === void 0) {
     return ms;
   }
-  const toFactor = unitConversion_[toUnit];
+  const toFactor = unitConversion[toUnit];
   if (toFactor === void 0) {
-    throw new Error(`invalid_unit`, { cause: { toUnit } });
+    throw new Error("invalid_unit", { cause: { toUnit } });
   }
   return ms / toFactor;
 };

package/dist/main.cjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/main.ts"],
-  "sourcesContent": ["import {isNumber} from '@alwatr/is-number';\nimport {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Unit conversion table\n */\nconst unitConversion_ = {\n  s: 1_000,\n  m: 60_000,\n  h: 3_600_000,\n  d: 86_400_000,\n  w: 604_800_000,\n  M: 2_592_000_000,\n  y: 31_536_000_000,\n} as const;\n\n/**\n * Duration unit: `s` for seconds, `m` for minutes, `h` for hours, `d` for days, `w` for weeks, `M` for months, `y` for years.\n */\nexport type DurationUnit = keyof typeof unitConversion_;\n\n/**\n * Duration string format: `number + unit`, for example `10m` means 10 minutes.\n */\nexport type Duration = `${number}${DurationUnit}` | number;\n\n/**\n * Parse duration string to milliseconds number.\n *\n * @param duration - duration string or number, for example `10m` means 10 minutes.\n * @param toUnit - convert to unit, default is `ms` for milliseconds.\n * @return duration in milliseconds.\n * @example\n * ```ts\n * parseDuration('10m'); // 600000\n * parseDuration('10m', 's'); // 600\n * parseDuration(120_000, 'm'); // 2\n * ```\n */\nexport const parseDuration = (duration: Duration, toUnit?: DurationUnit): number => {\n  let ms: number;\n\n  if (typeof duration === 'number') {\n    ms = duration;\n  }\n  else {\n    const durationNumberStr = duration.slice(0, duration.length - 1);\n    if (!isNumber(durationNumberStr)) {\n      throw new Error(`not_a_number`);\n    }\n    const durationNumber = +durationNumberStr;\n    const durationUnit = duration.slice(-1) as DurationUnit;\n    const unitConversionFactor = unitConversion_[durationUnit];\n    if (unitConversionFactor === undefined) {\n      throw new Error(`invalid_unit`, {cause: {duration}});\n    }\n    ms = durationNumber * unitConversionFactor;\n  }\n\n  if (toUnit === undefined) {\n    return ms;\n  }\n\n  // else\n  const toFactor = unitConversion_[toUnit];\n  if (toFactor === undefined) {\n    throw new Error(`invalid_unit`, {cause: {toUnit}});\n  }\n  return ms / toFactor;\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAuB;AACvB,4BAA4B;AAE5B,aAAc,qCAAc,IAAI,0BAAkB,OAAmB;AAKrE,IAAM,kBAAkB;AAAA,EACtB,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAyBO,IAAM,gBAAgB,CAAC,UAAoB,WAAkC;AAClF,MAAI;AAEJ,MAAI,OAAO,aAAa,UAAU;AAChC,SAAK;AAAA,EACP,OACK;AACH,UAAM,oBAAoB,SAAS,MAAM,GAAG,SAAS,SAAS,CAAC;AAC/D,QAAI,KAAC,2BAAS,iBAAiB,GAAG;AAChC,YAAM,IAAI,MAAM,cAAc;AAAA,IAChC;AACA,UAAM,iBAAiB,CAAC;AACxB,UAAM,eAAe,SAAS,MAAM,EAAE;AACtC,UAAM,uBAAuB,gBAAgB,YAAY;AACzD,QAAI,yBAAyB,QAAW;AACtC,YAAM,IAAI,MAAM,gBAAgB,EAAC,OAAO,EAAC,SAAQ,EAAC,CAAC;AAAA,IACrD;AACA,SAAK,iBAAiB;AAAA,EACxB;AAEA,MAAI,WAAW,QAAW;AACxB,WAAO;AAAA,EACT;AAGA,QAAM,WAAW,gBAAgB,MAAM;AACvC,MAAI,aAAa,QAAW;AAC1B,UAAM,IAAI,MAAM,gBAAgB,EAAC,OAAO,EAAC,OAAM,EAAC,CAAC;AAAA,EACnD;AACA,SAAO,KAAK;AACd;",
+  "sourcesContent": ["import {toNumber} from '@alwatr/is-number';\nimport {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Unit conversion table (milliseconds)\n */\nconst unitConversion = /* #__PURE__ */ Object.freeze({\n  s: 1_000,\n  m: 60_000,\n  h: 3_600_000,\n  d: 86_400_000,\n  w: 604_800_000,\n  M: 2_592_000_000,\n  y: 31_536_000_000,\n} as const);\n\n/**\n * Duration unit: `s` for seconds, `m` for minutes, `h` for hours, `d` for days, `w` for weeks, `M` for months, `y` for years.\n */\nexport type DurationUnit = keyof typeof unitConversion;\n\n/**\n * Duration string format: `number + unit`, for example `10m` means 10 minutes.\n */\nexport type Duration = `${number}${DurationUnit}` | number;\n\n/**\n * Error types that can be thrown by parseDuration\n */\nexport type DurationError = 'not_a_number' | 'invalid_unit' | 'invalid_format';\n\n/**\n * Parse duration string to milliseconds number.\n *\n * @param duration - Duration string or number, for example `10m` means 10 minutes.\n * @param toUnit - Convert to unit, default is `ms` for milliseconds.\n * @throws {Error} With message 'not_a_number' if duration string doesn't contain a valid number.\n * @throws {Error} With message 'invalid_unit' if the unit is not recognized.\n * @throws {Error} With message 'invalid_format' if the duration format is invalid.\n * @returns Duration in specified unit (or milliseconds by default).\n *\n * @example\n * ```ts\n * parseDuration('10m'); // 600000\n * parseDuration('10m', 's'); // 600\n * parseDuration(120_000, 'm'); // 2\n * ```\n */\nexport const parseDuration = (duration: Duration, toUnit?: DurationUnit): number => {\n  let ms: number;\n\n  // Convert input to milliseconds\n  if (typeof duration === 'number') {\n    ms = duration;\n  }\n  else {\n    if (duration.length < 2) {\n      throw new Error('invalid_format', {cause: {duration}});\n    }\n\n    const durationUnit = duration.slice(-1) as DurationUnit;\n    const unitConversionFactor = unitConversion[durationUnit];\n\n    if (unitConversionFactor === undefined) {\n      throw new Error('invalid_unit', {cause: {durationUnit}});\n    }\n\n    const durationNumber = toNumber(duration.slice(0, -1));\n    if (durationNumber === null) {\n      throw new Error('not_a_number', {cause: {duration}});\n    }\n\n    ms = durationNumber * unitConversionFactor;\n  }\n\n  // Return as is if no conversion needed\n  if (toUnit === undefined) {\n    return ms;\n  }\n\n  // Convert to target unit\n  const toFactor = unitConversion[toUnit];\n  if (toFactor === undefined) {\n    throw new Error('invalid_unit', {cause: {toUnit}});\n  }\n\n  return ms / toFactor;\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAuB;AACvB,4BAA4B;AAE5B,aAAc,qCAAc,IAAI,0BAAkB,OAAmB;AAKrE,IAAM,iBAAiC,uBAAO,OAAO;AAAA,EACnD,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL,CAAU;AAkCH,IAAM,gBAAgB,CAAC,UAAoB,WAAkC;AAClF,MAAI;AAGJ,MAAI,OAAO,aAAa,UAAU;AAChC,SAAK;AAAA,EACP,OACK;AACH,QAAI,SAAS,SAAS,GAAG;AACvB,YAAM,IAAI,MAAM,kBAAkB,EAAC,OAAO,EAAC,SAAQ,EAAC,CAAC;AAAA,IACvD;AAEA,UAAM,eAAe,SAAS,MAAM,EAAE;AACtC,UAAM,uBAAuB,eAAe,YAAY;AAExD,QAAI,yBAAyB,QAAW;AACtC,YAAM,IAAI,MAAM,gBAAgB,EAAC,OAAO,EAAC,aAAY,EAAC,CAAC;AAAA,IACzD;AAEA,UAAM,qBAAiB,2BAAS,SAAS,MAAM,GAAG,EAAE,CAAC;AACrD,QAAI,mBAAmB,MAAM;AAC3B,YAAM,IAAI,MAAM,gBAAgB,EAAC,OAAO,EAAC,SAAQ,EAAC,CAAC;AAAA,IACrD;AAEA,SAAK,iBAAiB;AAAA,EACxB;AAGA,MAAI,WAAW,QAAW;AACxB,WAAO;AAAA,EACT;AAGA,QAAM,WAAW,eAAe,MAAM;AACtC,MAAI,aAAa,QAAW;AAC1B,UAAM,IAAI,MAAM,gBAAgB,EAAC,OAAO,EAAC,OAAM,EAAC,CAAC;AAAA,EACnD;AAEA,SAAO,KAAK;AACd;",
   "names": []
 }

package/dist/main.d.ts

@@ -1,7 +1,7 @@
 /**
- * Unit conversion table
+ * Unit conversion table (milliseconds)
  */
-declare const unitConversion_: {
+declare const unitConversion: Readonly<{
     readonly s: 1000;
     readonly m: 60000;
     readonly h: 3600000;
@@ -9,21 +9,29 @@ declare const unitConversion_: {
     readonly w: 604800000;
     readonly M: 2592000000;
     readonly y: 31536000000;
-};
+}>;
 /**
  * Duration unit: `s` for seconds, `m` for minutes, `h` for hours, `d` for days, `w` for weeks, `M` for months, `y` for years.
  */
-export type DurationUnit = keyof typeof unitConversion_;
+export type DurationUnit = keyof typeof unitConversion;
 /**
  * Duration string format: `number + unit`, for example `10m` means 10 minutes.
  */
 export type Duration = `${number}${DurationUnit}` | number;
+/**
+ * Error types that can be thrown by parseDuration
+ */
+export type DurationError = 'not_a_number' | 'invalid_unit' | 'invalid_format';
 /**
  * Parse duration string to milliseconds number.
  *
- * @param duration - duration string or number, for example `10m` means 10 minutes.
- * @param toUnit - convert to unit, default is `ms` for milliseconds.
- * @return duration in milliseconds.
+ * @param duration - Duration string or number, for example `10m` means 10 minutes.
+ * @param toUnit - Convert to unit, default is `ms` for milliseconds.
+ * @throws {Error} With message 'not_a_number' if duration string doesn't contain a valid number.
+ * @throws {Error} With message 'invalid_unit' if the unit is not recognized.
+ * @throws {Error} With message 'invalid_format' if the duration format is invalid.
+ * @returns Duration in specified unit (or milliseconds by default).
+ *
  * @example
  * ```ts
  * parseDuration('10m'); // 600000

package/dist/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,QAAA,MAAM,eAAe;;;;;;;;CAQX,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,OAAO,eAAe,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,GAAG,MAAM,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;AAE3D;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,aAAa,aAAc,QAAQ,WAAW,YAAY,KAAG,MA8BzE,CAAC"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,QAAA,MAAM,cAAc;;;;;;;;EAQT,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,OAAO,cAAc,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,GAAG,MAAM,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAE/E;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,GAAI,UAAU,QAAQ,EAAE,SAAS,YAAY,KAAG,MAuCzE,CAAC"}

package/dist/main.mjs

@@ -1,10 +1,10 @@
-/* @alwatr/parse-duration v5.4.0 */
+/* @alwatr/parse-duration v5.5.1 */
 
 // src/main.ts
-import { isNumber } from "@alwatr/is-number";
+import { toNumber } from "@alwatr/is-number";
 import { packageTracer } from "@alwatr/package-tracer";
-__dev_mode__: packageTracer.add("@alwatr/parse-duration", "5.4.0");
-var unitConversion_ = {
+__dev_mode__: packageTracer.add("@alwatr/parse-duration", "5.5.1");
+var unitConversion = /* @__PURE__ */ Object.freeze({
   s: 1e3,
   m: 6e4,
   h: 36e5,
@@ -12,30 +12,32 @@ var unitConversion_ = {
   w: 6048e5,
   M: 2592e6,
   y: 31536e6
-};
+});
 var parseDuration = (duration, toUnit) => {
   let ms;
   if (typeof duration === "number") {
     ms = duration;
   } else {
-    const durationNumberStr = duration.slice(0, duration.length - 1);
-    if (!isNumber(durationNumberStr)) {
-      throw new Error(`not_a_number`);
+    if (duration.length < 2) {
+      throw new Error("invalid_format", { cause: { duration } });
     }
-    const durationNumber = +durationNumberStr;
     const durationUnit = duration.slice(-1);
-    const unitConversionFactor = unitConversion_[durationUnit];
+    const unitConversionFactor = unitConversion[durationUnit];
     if (unitConversionFactor === void 0) {
-      throw new Error(`invalid_unit`, { cause: { duration } });
+      throw new Error("invalid_unit", { cause: { durationUnit } });
+    }
+    const durationNumber = toNumber(duration.slice(0, -1));
+    if (durationNumber === null) {
+      throw new Error("not_a_number", { cause: { duration } });
     }
     ms = durationNumber * unitConversionFactor;
   }
   if (toUnit === void 0) {
     return ms;
   }
-  const toFactor = unitConversion_[toUnit];
+  const toFactor = unitConversion[toUnit];
   if (toFactor === void 0) {
-    throw new Error(`invalid_unit`, { cause: { toUnit } });
+    throw new Error("invalid_unit", { cause: { toUnit } });
   }
   return ms / toFactor;
 };

package/dist/main.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/main.ts"],
-  "sourcesContent": ["import {isNumber} from '@alwatr/is-number';\nimport {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Unit conversion table\n */\nconst unitConversion_ = {\n  s: 1_000,\n  m: 60_000,\n  h: 3_600_000,\n  d: 86_400_000,\n  w: 604_800_000,\n  M: 2_592_000_000,\n  y: 31_536_000_000,\n} as const;\n\n/**\n * Duration unit: `s` for seconds, `m` for minutes, `h` for hours, `d` for days, `w` for weeks, `M` for months, `y` for years.\n */\nexport type DurationUnit = keyof typeof unitConversion_;\n\n/**\n * Duration string format: `number + unit`, for example `10m` means 10 minutes.\n */\nexport type Duration = `${number}${DurationUnit}` | number;\n\n/**\n * Parse duration string to milliseconds number.\n *\n * @param duration - duration string or number, for example `10m` means 10 minutes.\n * @param toUnit - convert to unit, default is `ms` for milliseconds.\n * @return duration in milliseconds.\n * @example\n * ```ts\n * parseDuration('10m'); // 600000\n * parseDuration('10m', 's'); // 600\n * parseDuration(120_000, 'm'); // 2\n * ```\n */\nexport const parseDuration = (duration: Duration, toUnit?: DurationUnit): number => {\n  let ms: number;\n\n  if (typeof duration === 'number') {\n    ms = duration;\n  }\n  else {\n    const durationNumberStr = duration.slice(0, duration.length - 1);\n    if (!isNumber(durationNumberStr)) {\n      throw new Error(`not_a_number`);\n    }\n    const durationNumber = +durationNumberStr;\n    const durationUnit = duration.slice(-1) as DurationUnit;\n    const unitConversionFactor = unitConversion_[durationUnit];\n    if (unitConversionFactor === undefined) {\n      throw new Error(`invalid_unit`, {cause: {duration}});\n    }\n    ms = durationNumber * unitConversionFactor;\n  }\n\n  if (toUnit === undefined) {\n    return ms;\n  }\n\n  // else\n  const toFactor = unitConversion_[toUnit];\n  if (toFactor === undefined) {\n    throw new Error(`invalid_unit`, {cause: {toUnit}});\n  }\n  return ms / toFactor;\n};\n"],
-  "mappings": ";;;AAAA,SAAQ,gBAAe;AACvB,SAAQ,qBAAoB;AAE5B,aAAc,eAAc,IAAI,0BAAkB,OAAmB;AAKrE,IAAM,kBAAkB;AAAA,EACtB,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL;AAyBO,IAAM,gBAAgB,CAAC,UAAoB,WAAkC;AAClF,MAAI;AAEJ,MAAI,OAAO,aAAa,UAAU;AAChC,SAAK;AAAA,EACP,OACK;AACH,UAAM,oBAAoB,SAAS,MAAM,GAAG,SAAS,SAAS,CAAC;AAC/D,QAAI,CAAC,SAAS,iBAAiB,GAAG;AAChC,YAAM,IAAI,MAAM,cAAc;AAAA,IAChC;AACA,UAAM,iBAAiB,CAAC;AACxB,UAAM,eAAe,SAAS,MAAM,EAAE;AACtC,UAAM,uBAAuB,gBAAgB,YAAY;AACzD,QAAI,yBAAyB,QAAW;AACtC,YAAM,IAAI,MAAM,gBAAgB,EAAC,OAAO,EAAC,SAAQ,EAAC,CAAC;AAAA,IACrD;AACA,SAAK,iBAAiB;AAAA,EACxB;AAEA,MAAI,WAAW,QAAW;AACxB,WAAO;AAAA,EACT;AAGA,QAAM,WAAW,gBAAgB,MAAM;AACvC,MAAI,aAAa,QAAW;AAC1B,UAAM,IAAI,MAAM,gBAAgB,EAAC,OAAO,EAAC,OAAM,EAAC,CAAC;AAAA,EACnD;AACA,SAAO,KAAK;AACd;",
+  "sourcesContent": ["import {toNumber} from '@alwatr/is-number';\nimport {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Unit conversion table (milliseconds)\n */\nconst unitConversion = /* #__PURE__ */ Object.freeze({\n  s: 1_000,\n  m: 60_000,\n  h: 3_600_000,\n  d: 86_400_000,\n  w: 604_800_000,\n  M: 2_592_000_000,\n  y: 31_536_000_000,\n} as const);\n\n/**\n * Duration unit: `s` for seconds, `m` for minutes, `h` for hours, `d` for days, `w` for weeks, `M` for months, `y` for years.\n */\nexport type DurationUnit = keyof typeof unitConversion;\n\n/**\n * Duration string format: `number + unit`, for example `10m` means 10 minutes.\n */\nexport type Duration = `${number}${DurationUnit}` | number;\n\n/**\n * Error types that can be thrown by parseDuration\n */\nexport type DurationError = 'not_a_number' | 'invalid_unit' | 'invalid_format';\n\n/**\n * Parse duration string to milliseconds number.\n *\n * @param duration - Duration string or number, for example `10m` means 10 minutes.\n * @param toUnit - Convert to unit, default is `ms` for milliseconds.\n * @throws {Error} With message 'not_a_number' if duration string doesn't contain a valid number.\n * @throws {Error} With message 'invalid_unit' if the unit is not recognized.\n * @throws {Error} With message 'invalid_format' if the duration format is invalid.\n * @returns Duration in specified unit (or milliseconds by default).\n *\n * @example\n * ```ts\n * parseDuration('10m'); // 600000\n * parseDuration('10m', 's'); // 600\n * parseDuration(120_000, 'm'); // 2\n * ```\n */\nexport const parseDuration = (duration: Duration, toUnit?: DurationUnit): number => {\n  let ms: number;\n\n  // Convert input to milliseconds\n  if (typeof duration === 'number') {\n    ms = duration;\n  }\n  else {\n    if (duration.length < 2) {\n      throw new Error('invalid_format', {cause: {duration}});\n    }\n\n    const durationUnit = duration.slice(-1) as DurationUnit;\n    const unitConversionFactor = unitConversion[durationUnit];\n\n    if (unitConversionFactor === undefined) {\n      throw new Error('invalid_unit', {cause: {durationUnit}});\n    }\n\n    const durationNumber = toNumber(duration.slice(0, -1));\n    if (durationNumber === null) {\n      throw new Error('not_a_number', {cause: {duration}});\n    }\n\n    ms = durationNumber * unitConversionFactor;\n  }\n\n  // Return as is if no conversion needed\n  if (toUnit === undefined) {\n    return ms;\n  }\n\n  // Convert to target unit\n  const toFactor = unitConversion[toUnit];\n  if (toFactor === undefined) {\n    throw new Error('invalid_unit', {cause: {toUnit}});\n  }\n\n  return ms / toFactor;\n};\n"],
+  "mappings": ";;;AAAA,SAAQ,gBAAe;AACvB,SAAQ,qBAAoB;AAE5B,aAAc,eAAc,IAAI,0BAAkB,OAAmB;AAKrE,IAAM,iBAAiC,uBAAO,OAAO;AAAA,EACnD,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AAAA,EACH,GAAG;AACL,CAAU;AAkCH,IAAM,gBAAgB,CAAC,UAAoB,WAAkC;AAClF,MAAI;AAGJ,MAAI,OAAO,aAAa,UAAU;AAChC,SAAK;AAAA,EACP,OACK;AACH,QAAI,SAAS,SAAS,GAAG;AACvB,YAAM,IAAI,MAAM,kBAAkB,EAAC,OAAO,EAAC,SAAQ,EAAC,CAAC;AAAA,IACvD;AAEA,UAAM,eAAe,SAAS,MAAM,EAAE;AACtC,UAAM,uBAAuB,eAAe,YAAY;AAExD,QAAI,yBAAyB,QAAW;AACtC,YAAM,IAAI,MAAM,gBAAgB,EAAC,OAAO,EAAC,aAAY,EAAC,CAAC;AAAA,IACzD;AAEA,UAAM,iBAAiB,SAAS,SAAS,MAAM,GAAG,EAAE,CAAC;AACrD,QAAI,mBAAmB,MAAM;AAC3B,YAAM,IAAI,MAAM,gBAAgB,EAAC,OAAO,EAAC,SAAQ,EAAC,CAAC;AAAA,IACrD;AAEA,SAAK,iBAAiB;AAAA,EACxB;AAGA,MAAI,WAAW,QAAW;AACxB,WAAO;AAAA,EACT;AAGA,QAAM,WAAW,eAAe,MAAM;AACtC,MAAI,aAAa,QAAW;AAC1B,UAAM,IAAI,MAAM,gBAAgB,EAAC,OAAO,EAAC,OAAM,EAAC,CAAC;AAAA,EACnD;AAEA,SAAO,KAAK;AACd;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwatr/parse-duration",
-  "version": "5.4.0",
+  "version": "5.5.1",
   "description": "A simple utility to parse a duration string into milliseconds number.",
   "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
   "keywords": [
@@ -70,15 +70,15 @@
     "clean": "rm -rfv dist *.tsbuildinfo"
   },
   "dependencies": {
-    "@alwatr/is-number": "^5.4.0",
-    "@alwatr/package-tracer": "^5.4.0"
+    "@alwatr/is-number": "^5.6.0",
+    "@alwatr/package-tracer": "^5.5.1"
   },
   "devDependencies": {
-    "@alwatr/nano-build": "^5.4.0",
+    "@alwatr/nano-build": "^5.5.1",
     "@alwatr/prettier-config": "^5.0.0",
     "@alwatr/tsconfig-base": "^5.0.0",
     "jest": "^29.7.0",
-    "typescript": "^5.7.3"
+    "typescript": "^5.8.2"
   },
-  "gitHead": "074be0d0fe780bf929e163045f8f598cd2697636"
+  "gitHead": "21cb1fe0f26a580944d9e72a313fc99308cd8be7"
 }

package/src/main.test.js

@@ -1,30 +1,46 @@
 import {parseDuration} from '@alwatr/parse-duration';
 
 describe('@alwatr/parse-duration', () => {
-  it('should parse duration in seconds', () => {
-    expect(parseDuration('5s')).toBe(5 * 1000);
-  });
+  // Basic functionality tests
+  it('should parse duration strings to milliseconds', () => {
+    // Basic time units
+    expect(parseDuration('5s')).toBe(5 * 1_000); // seconds
+    expect(parseDuration('3m')).toBe(3 * 60_000); // minutes
+    expect(parseDuration('2h')).toBe(2 * 3_600_000); // hours
+    expect(parseDuration('1d')).toBe(1 * 86_400_000); // days
+    expect(parseDuration('2w')).toBe(2 * 604_800_000); // weeks
 
-  it('should parse duration in minutes', () => {
-    expect(parseDuration('3m')).toBe(3 * 60 * 1000);
+    // Longer time units
+    expect(parseDuration('3M')).toBe(3 * 2_592_000_000); // months
+    expect(parseDuration('1y')).toBe(1 * 31_536_000_000); // years
   });
 
-  it('should parse duration in hours', () => {
-    expect(parseDuration('2h')).toBe(2 * 60 * 60 * 1000);
+  it('should accept numeric input as milliseconds', () => {
+    expect(parseDuration(5000)).toBe(5000);
+    expect(parseDuration(0)).toBe(0);
   });
 
   it('should convert duration to specified unit', () => {
     expect(parseDuration('2h', 'm')).toBe(2 * 60);
-  });
-
-  it('should convert duration to different units', () => {
+    expect(parseDuration('120s', 'm')).toBe(2);
     expect(parseDuration('1d', 'h')).toBe(24);
     expect(parseDuration('1w', 'd')).toBe(7);
-    expect(parseDuration('1M', 'm')).toBe(30 * 24 * 60);
+    expect(parseDuration('1M', 'd')).toBe(30);
     expect(parseDuration('1y', 'd')).toBe(365);
+    expect(parseDuration(60000, 's')).toBe(60);
   });
 
-  it('should throw error for invalid duration', () => {
+  it('should handle decimal values correctly', () => {
+    expect(parseDuration('0.5h')).toBe(0.5 * 60 * 60 * 1000);
+    expect(parseDuration('1.5d', 'h')).toBe(36);
+  });
+
+  // Error handling tests
+  it('should throw error for invalid duration format', () => {
+    expect(() => parseDuration('m')).toThrow('invalid_format');
+  });
+
+  it('should throw error for invalid unit', () => {
     // @ts-expect-error testing invalid input
     expect(() => parseDuration('1x')).toThrow('invalid_unit');
   });
@@ -38,4 +54,14 @@ describe('@alwatr/parse-duration', () => {
     // @ts-expect-error testing invalid input
     expect(() => parseDuration('xh')).toThrow('not_a_number');
   });
+
+  // Edge cases
+  it('should handle zero values', () => {
+    expect(parseDuration('0s')).toBe(0);
+    expect(parseDuration('0m', 's')).toBe(0);
+  });
+
+  it('should handle large values', () => {
+    expect(parseDuration('999999h')).toBe(999999 * 3600000);
+  });
 });