@keyv/redis 4.3.1 → 4.3.3

package/README.md

@@ -54,7 +54,7 @@ Here is the same example but with the `Keyv` instance created with the `createKe
 ```js
 import { createKeyv } from '@keyv/redis';
 
-const keyv = createKeyv('redis://user:pass@localhost:6379', { namespace: 'my-namespace' });
+const keyv = createKeyv('redis://user:pass@localhost:6379');
 ```
 
 You only have to import the `@keyv/redis` library if you are using the `createKeyv` function. 🎉 Otherwise, you can import `Keyv` and `@keyv/redis` independently.
@@ -82,26 +82,28 @@ const redisOptions = {
 const keyv = new Keyv(new KeyvRedis(redisOptions));
 ```
 
-Or you can create a new Redis instance and pass it in with `KeyvOptions`:
+Or you can create a new Redis instance and pass it in with `KeyvOptions` such as setting the `store`:
 
 ```js
 import Keyv from 'keyv';
 import KeyvRedis, { createClient } from '@keyv/redis';
 
-const redis = createClient('redis://user:pass@localhost:6379', { namespace: 'my-namespace'});
+const redis = createClient('redis://user:pass@localhost:6379');
 const keyvRedis = new KeyvRedis(redis);
-const keyv = new Keyv({ store: keyvRedis });
+const keyv = new Keyv({ store: keyvRedis});
 ```
 
 # Namespaces
 
-You can set a namespace for your keys. This is useful if you want to manage your keys in a more organized way. Here is an example of how to set a namespace:
+You can set a namespace for your keys. This is useful if you want to manage your keys in a more organized way. Here is an example of how to set a `namespace` with the `store` option:
 
 ```js
 import Keyv from 'keyv';
-import KeyvRedis from '@keyv/redis';
+import KeyvRedis, { createClient } from '@keyv/redis';
 
-const keyv = new Keyv(new KeyvRedis('redis://user:pass@localhost:6379', { namespace: 'my-namespace' }));
+const redis = createClient('redis://user:pass@localhost:6379');
+const keyvRedis = new KeyvRedis(redis);
+const keyv = new Keyv({ store: keyvRedis, namespace: 'my-namespace' });
 ```
 
 This will prefix all keys with `my-namespace:`. You can also set the namespace after the fact:

package/dist/index.cjs

@@ -177,8 +177,12 @@ var KeyvRedis = class extends import_node_events.default {
    * Get the Redis URL used to connect to the server. This is used to get a connected client.
    */
   async getClient() {
-    if (!this._client.isOpen) {
-      await this._client.connect();
+    try {
+      if (!this._client.isOpen) {
+        await this._client.connect();
+      }
+    } catch (error) {
+      this.emit("error", error);
     }
     return this._client;
   }

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import EventEmitter from 'node:events';
-import { RedisClientType, RedisClusterType, RedisModules, RedisFunctions, RedisScripts, RedisClientOptions, RedisClusterOptions } from 'redis';
+import { RedisClientOptions, RedisClusterOptions, RedisClientType, RedisClusterType, RedisModules, RedisFunctions, RedisScripts } from 'redis';
 export { RedisClientOptions, RedisClientType, RedisClusterOptions, RedisClusterType, createClient, createCluster } from 'redis';
 import { KeyvStoreAdapter, KeyvEntry, Keyv } from 'keyv';
 export { Keyv } from 'keyv';

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import EventEmitter from 'node:events';
-import { RedisClientType, RedisClusterType, RedisModules, RedisFunctions, RedisScripts, RedisClientOptions, RedisClusterOptions } from 'redis';
+import { RedisClientOptions, RedisClusterOptions, RedisClientType, RedisClusterType, RedisModules, RedisFunctions, RedisScripts } from 'redis';
 export { RedisClientOptions, RedisClientType, RedisClusterOptions, RedisClusterType, createClient, createCluster } from 'redis';
 import { KeyvStoreAdapter, KeyvEntry, Keyv } from 'keyv';
 export { Keyv } from 'keyv';

package/dist/index.js

@@ -147,8 +147,12 @@ var KeyvRedis = class extends EventEmitter {
    * Get the Redis URL used to connect to the server. This is used to get a connected client.
    */
   async getClient() {
-    if (!this._client.isOpen) {
-      await this._client.connect();
+    try {
+      if (!this._client.isOpen) {
+        await this._client.connect();
+      }
+    } catch (error) {
+      this.emit("error", error);
     }
     return this._client;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyv/redis",
-  "version": "4.3.1",
+  "version": "4.3.3",
   "description": "Redis storage adapter for Keyv",
   "type": "module",
   "main": "dist/index.cjs",
@@ -36,16 +36,16 @@
   "dependencies": {
     "cluster-key-slot": "^1.1.2",
     "redis": "^4.7.0",
-    "keyv": "^5.3.1"
+    "keyv": "^5.3.2"
   },
   "devDependencies": {
-    "@vitest/coverage-v8": "^3.0.7",
+    "@vitest/coverage-v8": "^3.1.1",
     "rimraf": "^6.0.1",
     "timekeeper": "^2.3.1",
     "tsd": "^0.31.2",
-    "vitest": "^3.0.7",
+    "vitest": "^3.1.1",
     "xo": "^0.60.0",
-    "@keyv/test-suite": "^2.0.5"
+    "@keyv/test-suite": "^2.0.6"
   },
   "tsd": {
     "directory": "test"
@@ -59,8 +59,8 @@
   ],
   "scripts": {
     "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --clean",
-    "test": "xo --fix && vitest run --coverage --typecheck",
-    "test:ci": "xo && vitest --run --sequence.setupFiles=list --typecheck",
+    "test": "xo --fix && vitest run --coverage",
+    "test:ci": "xo && vitest --run --sequence.setupFiles=list",
     "clean": "rimraf ./node_modules ./coverage ./dist"
   }
 }