Merge pull request #182 from AnkanSaha/dev

Dev

package.json

@@ -1,6 +1,6 @@
 {
   "name": "outers",
-  "version": "8.3.0",
+  "version": "8.3.1",
   "description": "outers - a all in one package for your day to day use",
   "main": "./lib/Config/outer.js",
   "types": "./lib/Config/outer.d.ts",

source/Config/outer.ts

@@ -75,6 +75,7 @@ import RequestCounter from "../Middlewares/User Counter/Base.middleware"; // Imp
 // Import Functions Related Modules
 import IPChecker from "../Functions/IP Type Checker.function"; // Import IP Type Checker Module
 import getIPDetails from "../Functions/Get IP Details.function"; // Import Get IP Details Module
+import ReadRequestCount from "../Functions/Read Request Count"; // Import Read Request Count Module
 
 // Export Console Color Related Modules
 export const Console = Object.freeze({
@@ -154,4 +155,5 @@ export const FunctionBased = Object.freeze({
     PUT: PutFetch, // Export Put Fetch Module
     DELETE: DeleteFetch, // Export Delete
   },
+  ReadRequestCount, // Export Read Request Count Module
 }); // Export

source/Functions/Read Request Count.ts

@@ -0,0 +1,36 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { StorageInstance } from "../Middlewares/User Counter/Base.middleware"; // Import The Storage for Read Request Count
+
+// Interface for Read Request Count
+interface ReturnData {
+  status: number;
+  message: string;
+  Data: any[];
+  TotalData: number;
+}
+
+// Main Function
+/**
+ * Retrieves the request count from the storage.
+ * If a RequestDate is provided, retrieves the request count for that specific date.
+ * If no RequestDate is provided, retrieves the overall request count.
+ * @param {string} RequestDate - The date for which to retrieve the request count. If not provided, retrieves the overall request count.
+ * @param {string} RequestDate - The Date Must Be M/D/YYYY format. like : 3/8/2024
+ * @returns {Promise<number>} - A promise that resolves to the request count.
+ * @throws {Error} - If unable to read the request count from the storage.
+ */
+export default async function (RequestDate: string): Promise<ReturnData> {
+  try {
+    if (
+      RequestDate === undefined ||
+      RequestDate === null ||
+      RequestDate === ""
+    ) {
+      return await StorageInstance.Get(); // Get All Data in Storage File
+    } else {
+      return await StorageInstance.Get(RequestDate);
+    }
+  } catch (error) {
+    throw new Error("Unable to read the request count from the storage.");
+  }
+}