@alwatr/parse-duration 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 1.0.0 (2024-01-16)
+
+### Bug Fixes
+
+* **parse-duration:** remove unused variables ([500f272](https://github.com/Alwatr/nanolib/commit/500f2727373daf12b6b8b84032244a88f197948e)) by @adltalab
+
+### Features
+
+* **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/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 S. Ali Mihandoost
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+# Parse-duration
+
+A simple utility to parse a duration string into milliseconds number.
+
+## Installation
+
+```bash
+yarn add @alwatr/parse-duration
+```
+
+## 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
+```
+
+### Unit Table
+
+| Unit | Description |
+|------|--------|
+| `s`  | Second |
+| `m`  | Minute |
+| `h`  | Hour   |
+| `d`  | Day    |
+| `w`  | Week   |
+| `M`  | Month  |
+| `y`  | Year   |

package/dist/main.cjs

@@ -0,0 +1,3 @@
+/* @alwatr/parse-duration v1.0.0 */
+"use strict";var e=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var m=Object.getOwnPropertyNames;var d=Object.prototype.hasOwnProperty;var p=(r,n)=>{for(var t in n)e(r,t,{get:n[t],enumerable:!0})},w=(r,n,t,i)=>{if(n&&typeof n=="object"||typeof n=="function")for(let o of m(n))!d.call(r,o)&&o!==t&&e(r,o,{get:()=>n[o],enumerable:!(i=f(n,o))||i.enumerable});return r};var D=r=>w(e({},"__esModule",{value:!0}),r);var h={};p(h,{parseDuration:()=>b});module.exports=D(h);var c=require("@alwatr/is-number"),a={s:1e3,m:6e4,h:36e5,d:864e5,w:6048e5,M:2592e6,y:31536e6},b=(r,n)=>{let t=r.slice(0,r.length-1);if(!(0,c.isNumber)(t))throw new Error("not_a_number");let i=+t,o=r.slice(-1),u=a[o];if(u===void 0)throw new Error("invalid_unit",{cause:{duration:r}});let s=i*u;if(n===void 0)return s;let _=a[n];if(_===void 0)throw new Error("invalid_unit",{cause:{toUnit:n}});return s/_};0&&(module.exports={parseDuration});
+//# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["import {isNumber} from '@alwatr/is-number';\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 DurationString = `${number}${DurationUnit}`;\n\n/**\n * Parse duration string to milliseconds number.\n *\n * @param duration - duration string, 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 * ```\n */\nexport const parseDuration = (duration: DurationString, toUnit?: DurationUnit): number => {\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 factor = unitConversion_[durationUnit];\n  if (factor === undefined) {\n    throw new Error(`invalid_unit`, {cause: {duration}});\n  }\n  const ms = durationNumber * factor;\n  if (toUnit === undefined) {\n    return ms;\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": ";yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,mBAAAE,IAAA,eAAAC,EAAAH,GAAA,IAAAI,EAAuB,6BAKjBC,EAAkB,CACtB,EAAG,IACH,EAAG,IACH,EAAG,KACH,EAAG,MACH,EAAG,OACH,EAAG,OACH,EAAG,OACL,EAwBaH,EAAgB,CAACI,EAA0BC,IAAkC,CACxF,IAAMC,EAAoBF,EAAS,MAAM,EAAGA,EAAS,OAAS,CAAC,EAC/D,GAAI,IAAC,YAASE,CAAiB,EAC7B,MAAM,IAAI,MAAM,cAAc,EAEhC,IAAMC,EAAiB,CAACD,EAClBE,EAAeJ,EAAS,MAAM,EAAE,EAChCK,EAASN,EAAgBK,CAAY,EAC3C,GAAIC,IAAW,OACb,MAAM,IAAI,MAAM,eAAgB,CAAC,MAAO,CAAC,SAAAL,CAAQ,CAAC,CAAC,EAErD,IAAMM,EAAKH,EAAiBE,EAC5B,GAAIJ,IAAW,OACb,OAAOK,EAGT,IAAMC,EAAWR,EAAgBE,CAAM,EACvC,GAAIM,IAAa,OACf,MAAM,IAAI,MAAM,eAAgB,CAAC,MAAO,CAAC,OAAAN,CAAM,CAAC,CAAC,EAEnD,OAAOK,EAAKC,CACd",
+  "names": ["main_exports", "__export", "parseDuration", "__toCommonJS", "import_is_number", "unitConversion_", "duration", "toUnit", "durationNumberStr", "durationNumber", "durationUnit", "factor", "ms", "toFactor"]
+}

package/dist/main.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Unit conversion table
+ */
+declare const unitConversion_: {
+    readonly s: 1000;
+    readonly m: 60000;
+    readonly h: 3600000;
+    readonly d: 86400000;
+    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_;
+/**
+ * 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 declare const parseDuration: (duration: DurationString, toUnit?: DurationUnit) => number;
+export {};
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,QAAA,MAAM,eAAe;;;;;;;;CAQX,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,OAAO,eAAe,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,MAAM,GAAG,YAAY,EAAE,CAAC;AAExD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,aAAa,aAAc,cAAc,WAAW,YAAY,KAAG,MAqB/E,CAAC"}

package/dist/main.mjs

@@ -0,0 +1,3 @@
+/* @alwatr/parse-duration v1.0.0 */
+import{isNumber as a}from"@alwatr/is-number";var u={s:1e3,m:6e4,h:36e5,d:864e5,w:6048e5,M:2592e6,y:31536e6},f=(n,r)=>{let t=n.slice(0,n.length-1);if(!a(t))throw new Error("not_a_number");let s=+t,_=n.slice(-1),o=u[_];if(o===void 0)throw new Error("invalid_unit",{cause:{duration:n}});let i=s*o;if(r===void 0)return i;let e=u[r];if(e===void 0)throw new Error("invalid_unit",{cause:{toUnit:r}});return i/e};export{f as parseDuration};
+//# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["import {isNumber} from '@alwatr/is-number';\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 DurationString = `${number}${DurationUnit}`;\n\n/**\n * Parse duration string to milliseconds number.\n *\n * @param duration - duration string, 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 * ```\n */\nexport const parseDuration = (duration: DurationString, toUnit?: DurationUnit): number => {\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 factor = unitConversion_[durationUnit];\n  if (factor === undefined) {\n    throw new Error(`invalid_unit`, {cause: {duration}});\n  }\n  const ms = durationNumber * factor;\n  if (toUnit === undefined) {\n    return ms;\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,OAAQ,YAAAA,MAAe,oBAKvB,IAAMC,EAAkB,CACtB,EAAG,IACH,EAAG,IACH,EAAG,KACH,EAAG,MACH,EAAG,OACH,EAAG,OACH,EAAG,OACL,EAwBaC,EAAgB,CAACC,EAA0BC,IAAkC,CACxF,IAAMC,EAAoBF,EAAS,MAAM,EAAGA,EAAS,OAAS,CAAC,EAC/D,GAAI,CAACH,EAASK,CAAiB,EAC7B,MAAM,IAAI,MAAM,cAAc,EAEhC,IAAMC,EAAiB,CAACD,EAClBE,EAAeJ,EAAS,MAAM,EAAE,EAChCK,EAASP,EAAgBM,CAAY,EAC3C,GAAIC,IAAW,OACb,MAAM,IAAI,MAAM,eAAgB,CAAC,MAAO,CAAC,SAAAL,CAAQ,CAAC,CAAC,EAErD,IAAMM,EAAKH,EAAiBE,EAC5B,GAAIJ,IAAW,OACb,OAAOK,EAGT,IAAMC,EAAWT,EAAgBG,CAAM,EACvC,GAAIM,IAAa,OACf,MAAM,IAAI,MAAM,eAAgB,CAAC,MAAO,CAAC,OAAAN,CAAM,CAAC,CAAC,EAEnD,OAAOK,EAAKC,CACd",
+  "names": ["isNumber", "unitConversion_", "parseDuration", "duration", "toUnit", "durationNumberStr", "durationNumber", "durationUnit", "factor", "ms", "toFactor"]
+}

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@alwatr/parse-duration",
+  "version": "1.0.0",
+  "description": "A simple utility to parse a duration string into milliseconds number.",
+  "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
+  "keywords": [
+    "parse",
+    "duration",
+    "time",
+    "parse-duration",
+    "cross-platform",
+    "ECMAScript",
+    "typescript",
+    "javascript",
+    "node",
+    "nodejs",
+    "browser",
+    "esm",
+    "module",
+    "utility",
+    "util",
+    "utils",
+    "nanolib",
+    "alwatr"
+  ],
+  "type": "module",
+  "main": "./dist/main.cjs",
+  "module": "./dist/main.mjs",
+  "types": "./dist/main.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/main.mjs",
+      "require": "./dist/main.cjs",
+      "types": "./dist/main.d.ts"
+    }
+  },
+  "license": "MIT",
+  "files": [
+    "**/*.{js,mjs,cjs,map,d.ts,html,md}",
+    "!demo/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Alwatr/nanolib",
+    "directory": "packages/parse-duration"
+  },
+  "homepage": "https://github.com/Alwatr/nanolib/tree/next/packages/parse-duration#readme",
+  "bugs": {
+    "url": "https://github.com/Alwatr/nanolib/issues"
+  },
+  "prettier": "@alwatr/prettier-config",
+  "scripts": {
+    "b": "yarn run build",
+    "t": "yarn run test",
+    "w": "yarn run watch",
+    "c": "yarn run clean",
+    "cb": "yarn run clean && yarn run build",
+    "d": "yarn run build:es && yarn node --enable-source-maps --trace-warnings",
+    "build": "yarn run build:ts & yarn run build:es",
+    "build:es": "nano-build --preset=module",
+    "build:ts": "tsc --build",
+    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --enable-source-maps --experimental-vm-modules\" jest",
+    "watch": "yarn run watch:ts & yarn run watch:es",
+    "watch:es": "yarn run build:es --watch",
+    "watch:ts": "yarn run build:ts --watch --preserveWatchOutput",
+    "clean": "rm -rfv dist *.tsbuildinfo"
+  },
+  "dependencies": {
+    "@alwatr/is-number": "^1.0.0"
+  },
+  "devDependencies": {
+    "@alwatr/nano-build": "^1.3.1",
+    "@alwatr/prettier-config": "^1.0.4",
+    "@alwatr/tsconfig-base": "^1.1.1",
+    "@types/node": "^20.11.3",
+    "jest": "^29.7.0",
+    "typescript": "^5.3.3"
+  },
+  "gitHead": "369887cfdcbf5c6f3899880a5e217b102b36706c"
+}

package/src/main.test.js

@@ -0,0 +1,41 @@
+import {parseDuration} from '@alwatr/parse-duration';
+
+describe('@alwatr/parse-duration', () => {
+  it('should parse duration in seconds', () => {
+    expect(parseDuration('5s')).toBe(5 * 1000);
+  });
+
+  it('should parse duration in minutes', () => {
+    expect(parseDuration('3m')).toBe(3 * 60 * 1000);
+  });
+
+  it('should parse duration in hours', () => {
+    expect(parseDuration('2h')).toBe(2 * 60 * 60 * 1000);
+  });
+
+  it('should convert duration to specified unit', () => {
+    expect(parseDuration('2h', 'm')).toBe(2 * 60);
+  });
+
+  it('should convert duration to different units', () => {
+    expect(parseDuration('1d', 'h')).toBe(24);
+    expect(parseDuration('1w', 'd')).toBe(7);
+    expect(parseDuration('1M', 'm')).toBe(30 * 24 * 60);
+    expect(parseDuration('1y', 'd')).toBe(365);
+  });
+
+  it('should throw error for invalid duration', () => {
+    // @ts-expect-error testing invalid input
+    expect(() => parseDuration('1x')).toThrow('invalid_unit');
+  });
+
+  it('should throw error for invalid conversion unit', () => {
+    // @ts-expect-error testing invalid input
+    expect(() => parseDuration('1h', 'x')).toThrow('invalid_unit');
+  });
+
+  it('should throw error for non-numeric duration', () => {
+    // @ts-expect-error testing invalid input
+    expect(() => parseDuration('xh')).toThrow('not_a_number');
+  });
+});