Merge pull request #38 from vodyani/beta_8.x

Beta 8.x
vodyani · Sep 7, 2022 · 76dc3c1 · 76dc3c1
2 parents 38e7160 + 828fcf1
commit 76dc3c1
Show file tree

Hide file tree

Showing 27 changed files with 430 additions and 528 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,17 @@
+## [8.5.1](https://github.com/vodyani/utils/compare/v8.5.0...v8.5.1) (2022-08-31)
+
+
+### Bug Fixes
+
+* remove invalid dependency declarations ([d1e04e1](https://github.com/vodyani/utils/commit/d1e04e14cf57ae61c799f69ca2e089159f7173df))
+
+# [8.5.0](https://github.com/vodyani/utils/compare/v8.4.4...v8.5.0) (2022-08-31)
+
+
+### Features
+
+* adding common tools package ([02a641d](https://github.com/vodyani/utils/commit/02a641d9cf10f9330c159cd6a49aed66cfd0bd48))
+
 # [8.5.0-beta.1](https://github.com/vodyani/utils/compare/v8.4.4...v8.5.0-beta.1) (2022-08-31)
 
 

diff --git a/README.MD b/README.MD
@@ -32,6 +32,8 @@ npm install @vodyani/utils
 |:-:|
 |[ChoGathK](https://github.com/chogathK)|
 
+![Alt](https://repobeats.axiom.co/api/embed/1e23cf3a598d3f75555c9bccab6664de44857ab3.svg "Repobeats analytics image")
+
 ## License
 
 Vodyani utils is [MIT licensed](LICENSE).
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vodyani/utils",
   "license": "MIT",
-  "version": "8.5.0-beta.1",
+  "version": "8.5.1",
   "author": "ChoGathK",
   "description": "🏃🏻‍♀️ utils provides common utility functions used in server-side development.",
   "homepage": "https://github.com/vodyani/utils#readme",
@@ -60,26 +60,17 @@
     ]
   },
   "dependencies": {
-    "dayjs": "^1.11.0",
     "deepmerge-ts": "4.2.1",
-    "lodash": "4.17.21",
-    "module-alias": "^2.2.2",
-    "uuid": "^8.3.2"
-  },
-  "peerDependencies": {
-    "@types/module-alias": "2.0.1",
-    "@types/uuid": "^8.3.4"
+    "lodash": "4.17.21"
   },
   "devDependencies": {
     "@commitlint/cli": "16.3.0",
     "@commitlint/config-conventional": "16.2.4",
     "@nestjs/testing": "8.4.7",
     "@types/jest": "27.5.2",
     "@types/lodash": "4.14.182",
-    "@types/module-alias": "2.0.1",
     "@types/node": "16.11.56",
     "@types/supertest": "2.0.12",
-    "@types/uuid": "^8.3.4",
     "@vodyani/eslint-config": "^1.1.0",
     "husky": "7.0.4",
     "jest": "27.5.1",

diff --git a/src/common.ts b/src/common.ts
@@ -0,0 +1,31 @@
+export interface ConvertOptions {
+  /**
+   * When the received value does not correspond to expectations, this value is returned.
+   *
+   * @default null
+   */
+  default?: any;
+  /**
+   * The conversion is carried out if the outcome of the conditional validation function execution is true.
+   *
+   * @empale (num: number) => num > 0
+   */
+  condition?: (...args: any[]) => boolean;
+  /**
+   * The process that carries out the transition.
+   *
+   * @empale (data: any) => Number(data)
+   */
+  transformer?: Function;
+}
+
+export class PriorityElement<T = any> {
+  /**
+   * Priority Indicates the weight of the queue.
+   */
+  public weight: number;
+  /**
+   * The actual content.
+   */
+  public value: T;
+}
diff --git a/src/common/declare/index.ts b/src/common/declare/index.ts
diff --git a/src/common/declare/module-alias.ts b/src/common/declare/module-alias.ts
diff --git a/src/common/declare/time.ts b/src/common/declare/time.ts
diff --git a/src/common/declare/uuid.ts b/src/common/declare/uuid.ts
diff --git a/src/common/index.ts b/src/common/index.ts
diff --git a/src/common/interface.ts b/src/common/interface.ts
diff --git a/src/common/type.ts b/src/common/type.ts
diff --git a/src/method/circular.ts b/src/method/circular.ts
@@ -0,0 +1,30 @@
+/**
+ * Create a recurring scheduled task.
+ *
+ * @param callback A callback function that needs to be called periodically.
+ * @param interval number The cycle time, default 1000 (The time unit is milliseconds).
+ * @param args any[]  The callback argument.
+ *
+ * @publicApi
+ */
+export function circular(callback: Function, interval: number, ...args: any[]) {
+  let timer: NodeJS.Timeout = null;
+
+  const close = () => {
+    if (timer) clearTimeout(timer);
+  };
+
+  const regularly = () => {
+    close();
+    timer = setTimeout(regularlyHandler, interval);
+  };
+
+  const regularlyHandler = () => {
+    callback(...args);
+    regularly();
+  };
+
+  regularly();
+
+  return { close };
+}