descript-redis-cache 4.0.2 → 4.0.3

package/README.md

@@ -5,15 +5,23 @@ Plugin to use Redis as a cache in Descript
 
 ```js
 import de from 'descript';
-import deRedisCache from 'descript-redis-cache';
+import { Cache } from 'descript-redis-cache';
 
-const redisCache = new deRedisCache(options);
+const redisCache = new Cache(options);
+
+// subscribe to events if necessary
+// @see https://github.com/luin/ioredis#connection-events
+redisCache.getClient()
+    .on('reconnecting', () => {/* ... */})
+    .on('error', () => {/* ... */})
+    .on('close', () => {/* ... */})
+    .on('end', () => {/* ... */});
 
 const myBlock = de.http({
     block: { /* ... */ },
     options: {
-        key: ({ params }) => '_some_cache_key_from_params_',
-        cache: deRedisCache,
+        key: ({ params }) => '_some_cache_key_by_params_',
+        cache: redisCache,
     }
 });
 ```

package/build/index.d.ts

@@ -1,5 +1,6 @@
 import type { CacheInterface } from 'descript';
 import type { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis';
+import { Cluster, Redis } from 'ioredis';
 export interface Options {
     defaultKeyTTL?: number;
     generation?: number;
@@ -108,6 +109,7 @@ export type LoggerEvent = ({
 export declare class Cache<Result> implements CacheInterface<Result> {
     #private;
     constructor(options: Options, logger?: Logger);
+    getClient(): Cluster | Redis;
     get({ key }: {
         key: string;
     }): Promise<Result | undefined>;

package/build/index.js

@@ -43,6 +43,9 @@ class Cache {
             options: { ...__classPrivateFieldGet(this, _Cache_options, "f") },
         });
     }
+    getClient() {
+        return __classPrivateFieldGet(this, _Cache_client, "f");
+    }
     get({ key }) {
         const normalizedKey = __classPrivateFieldGet(this, _Cache_instances, "m", _Cache_normalizeKey).call(this, key);
         return new Promise((resolve, reject) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "descript-redis-cache",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "description": "plugin for descript to use redis as cache",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",