@keyv/redis 4.0.0 → 4.0.1

package/README.md

@@ -47,6 +47,16 @@ const keyv = new Keyv(new KeyvRedis('redis://user:pass@localhost:6379'));
 keyv.on('error', handleConnectionError);
 ```
 
+Here is the same example but with the `Keyv` instance created with the `createKeyv` function:
+
+```js
+import { createKeyv } from '@keyv/redis';
+
+const keyv = createKeyv('redis://user:pass@localhost:6379', { namespace: 'my-namespace' });
+```
+
+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.
+
 Here you can pass in the Redis options directly:
 
 ```js
@@ -81,17 +91,7 @@ const keyvRedis = new KeyvRedis(redis);
 const keyv = new Keyv({ store: keyvRedis });
 ```
 
-Here is the same example but with the `Keyv` instance created with the `createKeyv` function:
-
-```js
-import { createKeyv } from '@keyv/redis';
-
-const keyv = createKeyv('redis://user:pass@localhost:6379', { namespace: 'my-namespace' });
-```
-
-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.
-
-# Namspaces
+# 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:
 
@@ -121,7 +121,7 @@ With namespaces being prefix based it is critical to understand some of the perf
 
 * `useUnlink` - This option is set to `true` by default. This is because `UNLINK` is a non-blocking command that is more efficient than `DEL`. If you are not using `UNLINK` and are doing a lot of deletes it is recommended to set this option to `true`.
 
-* `setMany`, `getMany`, `deleteMany` - These methods are more efficient than their singular counterparts. If you are doing multiple operations it is recommended to use these methods.
+* `setMany`, `getMany`, `deleteMany` - These methods are more efficient than their singular counterparts. These will be used by default in the `Keyv` library such as when using `keyv.delete(string[])` it will use `deleteMany()`.
 
 If you want to see even better performance please see the [Using Cacheable with Redis](#using-cacheable-with-redis) section as it has non-blocking and in-memory primary caching that goes along well with this library and Keyv.
 
@@ -183,6 +183,8 @@ const cluster = createCluster({
 const keyv = new Keyv({ store: new KeyvRedis(cluster) });
 ```
 
+You can learn more about the `createCluster` function in the [documentation](https://github.com/redis/node-redis/blob/master/docs/clustering.md) at https://github.com/redis/node-redis/tree/master/docs.
+
 Here is an example of how to use TLS:
 
 ```js
@@ -227,7 +229,25 @@ const keyv = new Keyv({ store: new KeyvRedis(tlsOptions) });
 
 # Migrating from v3 to v4
 
-The main change in v4 is the removal of the `ioredis` library in favor of the `@keyv/redis` library. This was done to provide a more consistent experience across all Keyv storage adapters. The `@keyv/redis` library is a wrapper around the `redis` library and provides a more consistent experience across all Keyv storage adapters. The only other change is that we no longer do redis sets as they caused performance issues.
+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 `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`.
+* BREAKING: We no longer support redis sets. This is due to the fact that it caused significant performance issues and was not a good fit for the library.
+* BREAKING: YOUR PREVIOUS KEYS WILL NOT BE VALID. This is because of the fixe of the namespace support and how it is handled. Now, when using `keyv` with `@keyv/redis` as the storage adapter you can do the following:
+
+```js
+import Keyv from 'keyv';
+import KeyvRedis from '@keyv/redis';
+
+const redis = new KeyvRedis('redis://user:pass@localhost:6379');
+const keyv = new Keyv({ store: redis, namespace: 'my-namespace', useKeyPrefix: false });
+```
+
+This will make it so the storage adapter `@keyv/redis` will handle the namespace and not the `keyv` instance. If you leave it on it will just look duplicated like `my-namespace:my-namespace:key`.
+
+
 
 # About Redis Sets and its Support in v4
 

package/dist/index.cjs

@@ -409,7 +409,7 @@ var KeyvRedis = class extends import_events.default {
 };
 function createKeyv(connect, options) {
   const adapter = new KeyvRedis(connect, options);
-  const keyv = new import_keyv.Keyv({ store: adapter, namespace: options?.namespace });
+  const keyv = new import_keyv.Keyv({ store: adapter, namespace: options?.namespace, useKeyPrefix: false });
   return keyv;
 }
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.d.cts

@@ -200,7 +200,7 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
     private initClient;
 }
 /**
- * Will create a Keyv instance with the Redis adapter.
+ * Will create a Keyv instance with the Redis adapter. This will also set the namespace and useKeyPrefix to false.
  * @param connect
  * @param options
  * @returns {Keyv} - Keyv instance with the Redis adapter

package/dist/index.d.ts

@@ -200,7 +200,7 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
     private initClient;
 }
 /**
- * Will create a Keyv instance with the Redis adapter.
+ * Will create a Keyv instance with the Redis adapter. This will also set the namespace and useKeyPrefix to false.
  * @param connect
  * @param options
  * @returns {Keyv} - Keyv instance with the Redis adapter

package/dist/index.js

@@ -376,7 +376,7 @@ var KeyvRedis = class extends EventEmitter {
 };
 function createKeyv(connect, options) {
   const adapter = new KeyvRedis(connect, options);
-  const keyv = new Keyv({ store: adapter, namespace: options?.namespace });
+  const keyv = new Keyv({ store: adapter, namespace: options?.namespace, useKeyPrefix: false });
   return keyv;
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyv/redis",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Redis storage adapter for Keyv",
   "type": "module",
   "main": "dist/index.cjs",