feat(parse-duration): rewrite module 🤦🏻

Author: alimd

packages/parse-duration/README.md

@@ -1,6 +1,6 @@
 # Parse-duration
 
-A simple utility to parse a duration string into milliseconds.
+A simple utility to parse a duration string into milliseconds number.
 
 ## Installation
 
@@ -23,14 +23,14 @@ parseDuration('10y'); // 315,360,000,000
 parseDuration('10d', 'h'); // 240
 ```
 
-### Abbreviation Table
-
-| Abbreviation | Description |
-|--------------|-------------|
-|     `s`      |  Second     |
-|     `m`      |  Minute     |
-|     `h`      |  Hour       |
-|     `d`      |  Day        |
-|     `w`      |  Week       |
-|     `M`      |  Month      |
-|     `y`      |  Year       |
+### Unit Table
+
+| Unit | Description |
+|------|--------|
+| `s`  | Second |
+| `m`  | Minute |
+| `h`  | Hour   |
+| `d`  | Day    |
+| `w`  | Week   |
+| `M`  | Month  |
+| `y`  | Year   |

packages/parse-duration/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@alwatr/parse-duration",
   "version": "0.0.0",
-  "description": "A simple utility to parse a duration string into milliseconds.",
+  "description": "A simple utility to parse a duration string into milliseconds number.",
   "author": "S. Ali Mihandoost <[email protected]>",
   "keywords": [
     "parse",
@@ -14,9 +14,6 @@
     "javascript",
     "node",
     "nodejs",
-    "deno",
-    "web-worker",
-    "nwjs",
     "browser",
     "esm",
     "module",
@@ -75,8 +72,5 @@
     "@alwatr/tsconfig-base": "workspace:^",
     "@types/node": "^20.10.8",
     "typescript": "^5.3.3"
-  },
-  "dependencies": {
-    "@alwatr/is-number": "workspace:^"
   }
 }

packages/parse-duration/src/main.ts

@@ -1,9 +1,5 @@
 import {isNumber} from '@alwatr/is-number';
 
-import type {DurationString, DurationUnit} from './type';
-
-export * from './type';
-
 /**
  * Unit conversion table
  */
@@ -18,29 +14,46 @@ const unitConversion_ = {
 } as const;
 
 /**
- * Parse duration string to milliseconds
+ * 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_;
+
+/**
+ * Duration string format: `number + unit`, for example `10m` means 10 minutes.
+ */
+export type DurationString = `${number}${DurationUnit}`;
+
+/**
+ * Parse duration string to milliseconds number.
  *
  * @param duration - duration string, for example `10m` means 10 minutes.
  * @param toUnit - convert to unit, default is `ms` for milliseconds.
- *
  * @return duration in milliseconds.
- *
  * @example
  * ```ts
  * parseDuration('10m'); // 600000
  * parseDuration('10m', 's'); // 600
  * ```
  */
-export const parseDuration = (duration: DurationString, toUnit: DurationUnit | 'ms' = 'ms'): number => {
-  duration = duration.trim() as DurationString;
-  const durationNumberStr = duration.substring(0, duration.length - 1).trimEnd(); // trimEnd for `10 m`
+export const parseDuration = (duration: DurationString, toUnit?: DurationUnit): number => {
+  const durationNumberStr = duration.slice(0, duration.length - 1);
   if (!isNumber(durationNumberStr)) {
     throw new Error(`not_a_number`);
   }
   const durationNumber = +durationNumberStr;
-  const durationUnit = duration.substring(duration.length - 1) as DurationUnit;
-  if (unitConversion_[durationUnit] == null) {
-    throw new Error(`invalid_init`);
+  const durationUnit = duration.slice(-1) as DurationUnit;
+  const factor = unitConversion_[durationUnit];
+  if (factor === undefined) {
+    throw new Error(`invalid_unit`, {cause: {duration}});
+  }
+  const ms = durationNumber * factor;
+  if (toUnit === undefined) {
+    return ms;
+  }
+  // else
+  const toFactor = unitConversion_[toUnit];
+  if (toFactor === undefined) {
+    throw new Error(`invalid_unit`, {cause: {toUnit}});
   }
-  return (durationNumber * unitConversion_[durationUnit]) / (toUnit === 'ms' ? 1 : unitConversion_[toUnit]);
+  return ms / toFactor;
 };

packages/parse-duration/src/type.ts

@@ -6,5 +6,8 @@
     "emitDeclarationOnly": true,
     "composite": true,
   },
-  "include": ["src/**/*.ts"]
+  "include": ["src/**/*.ts"],
+  "references": [
+    {"path": "../is-number"}
+  ]
 }