@keyv/redis 4.3.4 → 4.4.1

package/README.md

@@ -10,7 +10,7 @@
 Redis storage adapter for [Keyv](https://github.com/jaredwray/keyv).
 
 # Features
-* Built on top of [redis](https://npmjs.com/package/redis).
+* Built on top of [@redis/client](https://npmjs.com/package/@redis/client).
 * TTL is handled directly by Redis.
 * Supports Redis Clusters.
 * Url connection string support or pass in your Redis Options
@@ -37,6 +37,12 @@ Redis storage adapter for [Keyv](https://github.com/jaredwray/keyv).
 * [About Redis Sets and its Support in v4](#about-redis-sets-and-its-support-in-v4)
 * [License](#license)
 
+# Installation
+
+```bash
+npm install --save keyv @keyv/redis
+```
+
 # Usage
 
 Here is a standard use case where we implement `Keyv` and `@keyv/redis`:
@@ -244,8 +250,8 @@ const keyv = new Keyv({ store: new KeyvRedis(tlsOptions) });
 * **constructor([connection], [options])**
 * **namespace** - The namespace to use for the keys.
 * **client** - The Redis client instance.
-* **keyPrefixSeparator** - The separator to use between the namespace and key.
-* **clearBatchSize** - The number of keys to delete in a single batch.
+* **keyPrefixSeparator** - The separator to use between the namespace and key. It can be set to a blank string.
+* **clearBatchSize** - The number of keys to delete in a single batch. Has to be greater than 0. Default is `1000`.
 * **useUnlink** - Use the `UNLINK` command for deleting keys isntead of `DEL`.
 * **noNamespaceAffectsAll**: Whether to allow clearing all keys when no namespace is set (default is `false`).
 * **set** - Set a key.
@@ -288,7 +294,7 @@ Here are some of the events you can listen to: https://www.npmjs.com/package/red
 # Migrating from v3 to v4
 
 Overall the API is the same as v3 with additional options and performance improvements. Here are the main changes:
-* The `ioredis` library has been removed in favor of the `redis` aka `node-redis` library. If you want to use ioredis you can use `@keyv/keyval`
+* The `ioredis` library has been removed in favor of the `redis` aka `node-redis` library. If you want to use ioredis you can use `@keyv/valkey`
 * The `useUnlink` option has been added to use `UNLINK` instead of `DEL` and set to true by default.
 * The `clearBatchSize` option has been added to set the number of keys to delete in a single batch.
 * The `clear()` and `delete()` methods now use `UNLINK` instead of `DEL`. If you want to use `DEL` you can set the `useUnlink` option to `false`.

package/dist/index.cjs

@@ -31,20 +31,20 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   Keyv: () => import_keyv2.Keyv,
-  createClient: () => import_redis2.createClient,
-  createCluster: () => import_redis2.createCluster,
+  createClient: () => import_client2.createClient,
+  createCluster: () => import_client2.createCluster,
   createKeyv: () => createKeyv,
   default: () => KeyvRedis
 });
 module.exports = __toCommonJS(index_exports);
 var import_node_events = __toESM(require("events"), 1);
-var import_redis = require("redis");
+var import_client = require("@redis/client");
 var import_keyv = require("keyv");
 var import_cluster_key_slot = __toESM(require("cluster-key-slot"), 1);
-var import_redis2 = require("redis");
+var import_client2 = require("@redis/client");
 var import_keyv2 = require("keyv");
 var KeyvRedis = class extends import_node_events.default {
-  _client = (0, import_redis.createClient)();
+  _client = (0, import_client.createClient)();
   _namespace;
   _keyPrefixSeparator = "::";
   _clearBatchSize = 1e3;
@@ -59,11 +59,11 @@ var KeyvRedis = class extends import_node_events.default {
     super();
     if (connect) {
       if (typeof connect === "string") {
-        this._client = (0, import_redis.createClient)({ url: connect });
+        this._client = (0, import_client.createClient)({ url: connect });
       } else if (connect.connect !== void 0) {
         this._client = this.isClientCluster(connect) ? connect : connect;
       } else if (connect instanceof Object) {
-        this._client = connect.rootNodes === void 0 ? (0, import_redis.createClient)(connect) : (0, import_redis.createCluster)(connect);
+        this._client = connect.rootNodes === void 0 ? (0, import_client.createClient)(connect) : (0, import_client.createCluster)(connect);
       }
     }
     this.setOptions(options);
@@ -86,9 +86,12 @@ var KeyvRedis = class extends import_node_events.default {
    * Get the options for the adapter.
    */
   get opts() {
-    let url = "";
+    let url = "redis://localhost:6379";
     if (this._client.options) {
-      url = this._client.options?.url ?? "redis://localhost:6379";
+      const redisUrl = this._client.options?.url;
+      if (redisUrl) {
+        url = redisUrl;
+      }
     }
     const results = {
       namespace: this._namespace,
@@ -143,7 +146,11 @@ var KeyvRedis = class extends import_node_events.default {
    * Set the number of keys to delete in a single batch.
    */
   set clearBatchSize(value) {
-    this._clearBatchSize = value;
+    if (value > 0) {
+      this._clearBatchSize = value;
+    } else {
+      this.emit("error", "clearBatchSize must be greater than 0");
+    }
   }
   /**
    * Get if Unlink is used instead of Del for clearing keys. This is more performant but may not be supported by all Redis versions.
@@ -501,10 +508,10 @@ var KeyvRedis = class extends import_node_events.default {
     if (options.namespace) {
       this._namespace = options.namespace;
     }
-    if (options.keyPrefixSeparator) {
+    if (options.keyPrefixSeparator !== void 0) {
       this._keyPrefixSeparator = options.keyPrefixSeparator;
     }
-    if (options.clearBatchSize) {
+    if (options.clearBatchSize !== void 0 && options.clearBatchSize > 0) {
       this._clearBatchSize = options.clearBatchSize;
     }
     if (options.useUnlink !== void 0) {
@@ -523,7 +530,7 @@ var KeyvRedis = class extends import_node_events.default {
 function createKeyv(connect, options) {
   connect ??= "redis://localhost:6379";
   const adapter = new KeyvRedis(connect, options);
-  const keyv = new import_keyv.Keyv({ store: adapter, namespace: options?.namespace, useKeyPrefix: false });
+  const keyv = new import_keyv.Keyv(adapter, { namespace: options?.namespace, useKeyPrefix: false });
   return keyv;
 }
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.d.cts

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

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,15 +1,15 @@
 // src/index.ts
-import EventEmitter from "node:events";
+import EventEmitter from "events";
 import {
   createClient,
   createCluster
-} from "redis";
+} from "@redis/client";
 import { Keyv } from "keyv";
 import calculateSlot from "cluster-key-slot";
 import {
   createClient as createClient2,
   createCluster as createCluster2
-} from "redis";
+} from "@redis/client";
 import {
   Keyv as Keyv2
 } from "keyv";
@@ -56,9 +56,12 @@ var KeyvRedis = class extends EventEmitter {
    * Get the options for the adapter.
    */
   get opts() {
-    let url = "";
+    let url = "redis://localhost:6379";
     if (this._client.options) {
-      url = this._client.options?.url ?? "redis://localhost:6379";
+      const redisUrl = this._client.options?.url;
+      if (redisUrl) {
+        url = redisUrl;
+      }
     }
     const results = {
       namespace: this._namespace,
@@ -113,7 +116,11 @@ var KeyvRedis = class extends EventEmitter {
    * Set the number of keys to delete in a single batch.
    */
   set clearBatchSize(value) {
-    this._clearBatchSize = value;
+    if (value > 0) {
+      this._clearBatchSize = value;
+    } else {
+      this.emit("error", "clearBatchSize must be greater than 0");
+    }
   }
   /**
    * Get if Unlink is used instead of Del for clearing keys. This is more performant but may not be supported by all Redis versions.
@@ -471,10 +478,10 @@ var KeyvRedis = class extends EventEmitter {
     if (options.namespace) {
       this._namespace = options.namespace;
     }
-    if (options.keyPrefixSeparator) {
+    if (options.keyPrefixSeparator !== void 0) {
       this._keyPrefixSeparator = options.keyPrefixSeparator;
     }
-    if (options.clearBatchSize) {
+    if (options.clearBatchSize !== void 0 && options.clearBatchSize > 0) {
       this._clearBatchSize = options.clearBatchSize;
     }
     if (options.useUnlink !== void 0) {
@@ -493,7 +500,7 @@ var KeyvRedis = class extends EventEmitter {
 function createKeyv(connect, options) {
   connect ??= "redis://localhost:6379";
   const adapter = new KeyvRedis(connect, options);
-  const keyv = new Keyv({ store: adapter, namespace: options?.namespace, useKeyPrefix: false });
+  const keyv = new Keyv(adapter, { namespace: options?.namespace, useKeyPrefix: false });
   return keyv;
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyv/redis",
-  "version": "4.3.4",
+  "version": "4.4.1",
   "description": "Redis storage adapter for Keyv",
   "type": "module",
   "main": "dist/index.cjs",
@@ -34,20 +34,20 @@
   },
   "homepage": "https://github.com/jaredwray/keyv",
   "dependencies": {
-    "cluster-key-slot": "^1.1.2",
-    "redis": "^4.7.0"
+    "@redis/client": "^1.6.0",
+    "cluster-key-slot": "^1.1.2"
   },
   "peerDependencies": {
-    "keyv": "^5.3.3"
+    "keyv": "^5.3.4"
   },
   "devDependencies": {
-    "@vitest/coverage-v8": "^3.1.1",
+    "@vitest/coverage-v8": "^3.2.3",
     "rimraf": "^6.0.1",
     "timekeeper": "^2.3.1",
-    "tsd": "^0.31.2",
-    "vitest": "^3.1.1",
-    "xo": "^0.60.0",
-    "@keyv/test-suite": "^2.0.6"
+    "tsd": "^0.32.0",
+    "vitest": "^3.2.3",
+    "xo": "^1.1.0",
+    "@keyv/test-suite": "^2.0.8"
   },
   "tsd": {
     "directory": "test"
@@ -62,7 +62,7 @@
   "scripts": {
     "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --clean",
     "test": "xo --fix && vitest run --coverage",
-    "test:ci": "xo && vitest --run --sequence.setupFiles=list",
+    "test:ci": "xo && vitest --run --sequence.setupFiles=list --coverage",
     "clean": "rimraf ./node_modules ./coverage ./dist"
   }
 }