@hastehaul/common 1.0.18 → 1.0.20

package/build/connections-wrappers/redis-connection-wrapper.d.ts

@@ -1,6 +1,7 @@
 import IORedis from "ioredis";
 /**
- * A wrapper class for the Redis client to manage connections and provide a centralized client instance.
+ * A wrapper class for the Redis client. This class manages connections and provides
+ * a centralized client instance for a Redis database.
  */
 export declare class RedisWrapper {
     private _redisClient?;
@@ -14,11 +15,14 @@ export declare class RedisWrapper {
      */
     get client(): IORedis;
     /**
-     * Connect to the Redis server using the specified host and port.
-     *
-     * The client instance will be stored in the `_redisClient` property for later access.
-     */
-    connect(): void;
+      * Connect to the Redis server using the specified host and port.
+      *
+      * The client instance will be stored in the `_redisClient` property for later access.
+      *
+      * @param {string} host - The Redis server host address (default is "customer-redis-srv").
+      * @param {number} port - The Redis server port number (default is 6379).
+      */
+    connect(host?: string, port?: number): void;
 }
 /**
  * Singleton instance of the RedisWrapper class to provide a centralized Redis client connection.

package/build/connections-wrappers/redis-connection-wrapper.js

@@ -6,7 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.redisWrapper = exports.RedisWrapper = void 0;
 const ioredis_1 = __importDefault(require("ioredis"));
 /**
- * A wrapper class for the Redis client to manage connections and provide a centralized client instance.
+ * A wrapper class for the Redis client. This class manages connections and provides
+ * a centralized client instance for a Redis database.
  */
 class RedisWrapper {
     constructor() {
@@ -25,12 +26,15 @@ class RedisWrapper {
         return this._redisClient;
     }
     /**
-     * Connect to the Redis server using the specified host and port.
-     *
-     * The client instance will be stored in the `_redisClient` property for later access.
-     */
-    connect() {
-        this._redisClient = new ioredis_1.default({ host: this.host, port: this.port, maxRetriesPerRequest: null });
+      * Connect to the Redis server using the specified host and port.
+      *
+      * The client instance will be stored in the `_redisClient` property for later access.
+      *
+      * @param {string} host - The Redis server host address (default is "customer-redis-srv").
+      * @param {number} port - The Redis server port number (default is 6379).
+      */
+    connect(host, port) {
+        this._redisClient = new ioredis_1.default({ host: host || this.host, port: port || this.port, maxRetriesPerRequest: null });
         this._redisClient.on("connect", function () {
             console.info("Redis Server Connected!");
         });

package/build/index.d.ts

@@ -86,6 +86,7 @@ export * from "./utils/enums";
  */
 export * from "./utils/read-dir";
 export * from "./utils/schemas";
+export * from "./utils/random-codes";
 /**
  *? Re-exports all the contents from the "base-producers" module.
  *

package/build/index.js

@@ -113,6 +113,8 @@ __exportStar(require("./utils/enums"), exports);
 __exportStar(require("./utils/read-dir"), exports);
 //TODO: DOCUMENT
 __exportStar(require("./utils/schemas"), exports);
+//TODO: DOCUMENT
+__exportStar(require("./utils/random-codes"), exports);
 /**
  *? Re-exports all the contents from the "base-producers" module.
  *

package/build/utils/random-codes.d.ts

@@ -9,4 +9,4 @@
  *
  * @returns {Promise<string>} - A Promise that resolves with the generated codes as a string.
  */
-declare function generateRandomCodesAsync(characters: string, numberOfCodes: number, codeSize: number, includeHyphens: boolean, chunkSize: number): Promise<string>;
+export declare function generateRandomCodesAsync(characters: string, numberOfCodes: number, codeSize: number, includeHyphens: boolean, chunkSize: number): Promise<string>;

package/build/utils/random-codes.js

@@ -8,6 +8,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateRandomCodesAsync = void 0;
 /**
  * Generates random codes as an async function using await.
  *
@@ -50,3 +52,4 @@ function generateRandomCodesAsync(characters, numberOfCodes, codeSize, includeHy
         return codes;
     });
 }
+exports.generateRandomCodesAsync = generateRandomCodesAsync;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hastehaul/common",
-  "version": "1.0.18",
+  "version": "1.0.20",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",