Merge pull request #4 from quizizz/chore/type-improvements

Chore/type improvements

Author: anaskhan96

lib/index.d.ts

@@ -1,20 +1,56 @@
 /// <reference types="node" />
-import IoRedis from 'ioredis';
-import EventEmitter from 'events';
+import { Redis as _Redis, Cluster } from "ioredis";
+import EventEmitter from "events";
+interface RedisConfig {
+    /** provide host ip/url, default - localhost */
+    host?: string;
+    /** provide the port number, default - 6379 */
+    port?: number;
+    /** provide the db number, default - 0 */
+    db?: number;
+    /** enable auto pipelining, default - false */
+    autoPipelining?: boolean;
+    /** provide auth if needed */
+    auth?: {
+        use: boolean;
+        password: string;
+    };
+    /** provide command timeout (not applicable for cluster), default - false */
+    commandTimeout?: number;
+    /** cluster config */
+    cluster?: {
+        use: boolean;
+        hosts: {
+            host: string;
+            port: number;
+        }[];
+        autoPipelining?: boolean;
+    };
+    /** sentinel config */
+    sentinel?: {
+        use: boolean;
+        hosts: {
+            host: string;
+            port: number;
+        }[];
+        name: string;
+        autoPipelining?: boolean;
+    };
+}
 /**
  * @class Redis
  */
 declare class Redis {
     name: string;
     emitter: EventEmitter;
-    config: Record<string, any>;
-    client: IoRedis.Cluster | IoRedis.Redis;
+    config: RedisConfig;
+    client: Cluster | _Redis;
     /**
      * @param {string} name - unique name to this service
      * @param {EventEmitter} emitter
-     * @param {Object} config - configuration object of service
+     * @param {RedisConfig} config - configuration object of service
      */
-    constructor(name: string, emitter: EventEmitter, config: Record<string, any>);
+    constructor(name: string, emitter: EventEmitter, config: RedisConfig);
     log(message: string, data: unknown): void;
     success(message: string, data: unknown): void;
     error(err: Error, data: unknown): void;