@heady/redis-client 1.0.0 → 1.0.1

package/README.md

@@ -2,7 +2,7 @@
 
 ![Language](https://img.shields.io/badge/language-TypeScript-blue)
 ![License](https://img.shields.io/badge/license-MIT-green)
-![Version](https://img.shields.io/badge/version-1.0.0-orange)
+![Version](https://img.shields.io/badge/version-1.0.1-orange)
 
 **Redis Client** is a lightweight, type-safe wrapper for [ioredis](https://github.com/luin/ioredis). It solves the problem of scaling Redis infrastructure by automatically routing **Write** operations to a Primary node and **Read** operations to Replica nodes.
 
@@ -21,7 +21,7 @@
 
 ## ✨ Features
 
-* **Automatic Traffic Splitting:** Writes (`set`, `del`, `expire`) are sent to the Primary; Reads (`get`, `scan`, `hget`) are sent to Replicas.
+* **Automatic Traffic Splitting:** Writes (`set`, `del`, `expire`) are sent to the Primary; Reads (`get`, `scan`, `hget`, `keys`) are sent to Replicas.
 * **Type Safety:** Built with TypeScript, providing full IntelliSense and type checking out of the box.
 * **Performance:** Offloads expensive read operations (like `SCAN`) from your Master node to prevent blocking critical write traffic.
 * **Flexible Access:** Exposes the underlying `ioredis` instances if you need to run custom or unsupported commands.
@@ -40,17 +40,18 @@ Before you begin, ensure you have met the following requirements:
 
 1. **Install the package and the peer dependency:**
    ```bash
-   npm install redis-client
+   npm install @heady/redis-client
+   ```
 
 ---
 
 ## 💡 Usage
 
 ``` typescript
-import { Redis } from 'redis-client';
+import { RedisClient } from '@heady/redis-client';
 
 // 1. Initialize with separate endpoints
-const redis = new Redis({
+const redis = new RedisClient({
   primary: {
     host: 'primary-node.redis.aws.internal',
     port: 6379,
@@ -128,23 +129,6 @@ Expected Output:
     ✓ get() should call replica node
 ```
 
-## 🤝 Contributing
-
-Contributions are always welcome! Please follow these steps:
-
-    Fork the project.
-
-    Create your feature branch (git checkout -b feature/NewFeature).
-
-    Commit your changes (git commit -m 'Add some NewFeature').
-
-    Run tests to ensure no regressions (npm test).
-
-    Push to the branch.
-
-    Open a Pull Request.
-
-
 ## 📜 License
 
 This project is licensed under the MIT License - see the LICENSE file for details.

package/dist/redisClient.d.ts

@@ -22,6 +22,7 @@ export declare class RedisClient {
     hget(key: string, field: string): Promise<string | null>;
     hgetall(key: string): Promise<Record<string, string>>;
     scan(cursor: string, matchPattern: string, count?: number): Promise<[string, string[]]>;
+    keys(pattern: string): Promise<string[]>;
     /**
      * -------------------------
      * UTILITIES

package/dist/redisClient.js

@@ -52,6 +52,9 @@ class RedisClient {
     async scan(cursor, matchPattern, count = 100) {
         return this.replica.scan(cursor, "MATCH", matchPattern, "COUNT", count);
     }
+    async keys(pattern) {
+        return this.replica.keys(pattern);
+    }
     /**
      * -------------------------
      * UTILITIES

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heady/redis-client",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [