@keyv/redis 5.1.6 → 6.0.0-alpha.1

package/README.md

@@ -419,34 +419,42 @@ You can learn more about the `createCluster` function in the [documentation](htt
 
 # Sentinel
 
-If you are using Sentinel to provide high availability for your Redis instances, you can pass in the `redisOptions` directly. Here is an example of how to do that:
+If you are using Sentinel to provide high availability for your Redis instances, you can pass in the sentinel options directly to the `KeyvRedis` constructor:
 
 ```js
 import Keyv from 'keyv';
-import KeyvRedis, { createSentinel } from '@keyv/redis';
+import KeyvRedis from '@keyv/redis';
 
-const sentinel = createSentinel({
-    name: 'sentinel-db',
+const keyv = new Keyv({
+  store: new KeyvRedis({
+    name: 'mymaster',
     sentinelRootNodes: [
-      {
-        host: '127.0.0.1',
-        port: 26379,
-      },
-      {
-        host: '127.0.0.1',
-        port: 26380,
-      },
-      {
-        host: '127.0.0.1',
-        port: 26381,
-      },
+      { host: '127.0.0.1', port: 26379 },
+      { host: '127.0.0.1', port: 26380 },
+      { host: '127.0.0.1', port: 26381 },
     ],
+  }),
 });
+```
+
+For TypeScript users, the `RedisSentinelOptions` type is exported from the package:
+
+```typescript
+import KeyvRedis, { type RedisSentinelOptions } from '@keyv/redis';
+
+const sentinelOptions: RedisSentinelOptions = {
+  name: 'mymaster',
+  sentinelRootNodes: [
+    { host: '127.0.0.1', port: 26379 },
+    { host: '127.0.0.1', port: 26380 },
+    { host: '127.0.0.1', port: 26381 },
+  ],
+};
 
-const keyv = new Keyv({ store: new KeyvRedis(sentinel) });
+const keyvRedis = new KeyvRedis(sentinelOptions);
 ```
 
-You can learn more about the `createSentinel` function in the [documentation](https://github.com/redis/node-redis/blob/master/docs/sentinel.md) at https://github.com/redis/node-redis/tree/master/docs.
+You can learn more about Sentinel configuration in the [documentation](https://github.com/redis/node-redis/blob/master/docs/sentinel.md) at https://github.com/redis/node-redis/tree/master/docs.
 
 # TLS Support
 

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { RedisClientType, RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping, RedisClusterType, RedisSentinelType, RedisClientOptions, RedisClusterOptions, RedisSentinelOptions } from '@redis/client';
-export { RedisClientOptions, RedisClientType, RedisClusterOptions, RedisClusterType, RedisSentinelType, createClient, createCluster, createSentinel } from '@redis/client';
+export { RedisClientOptions, RedisClientType, RedisClusterOptions, RedisClusterType, RedisSentinelOptions, RedisSentinelType, createClient, createCluster, createSentinel } from '@redis/client';
 import { Hookified } from 'hookified';
 import { Keyv, KeyvStoreAdapter, KeyvEntry } from 'keyv';
 export { Keyv } from 'keyv';

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { RedisClientType, RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping, RedisClusterType, RedisSentinelType, RedisClientOptions, RedisClusterOptions, RedisSentinelOptions } from '@redis/client';
-export { RedisClientOptions, RedisClientType, RedisClusterOptions, RedisClusterType, RedisSentinelType, createClient, createCluster, createSentinel } from '@redis/client';
+export { RedisClientOptions, RedisClientType, RedisClusterOptions, RedisClusterType, RedisSentinelOptions, RedisSentinelType, createClient, createCluster, createSentinel } from '@redis/client';
 import { Hookified } from 'hookified';
 import { Keyv, KeyvStoreAdapter, KeyvEntry } from 'keyv';
 export { Keyv } from 'keyv';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyv/redis",
-  "version": "5.1.6",
+  "version": "6.0.0-alpha.1",
   "description": "Redis storage adapter for Keyv",
   "type": "module",
   "main": "./dist/index.js",
@@ -45,7 +45,7 @@
     "hookified": "^1.13.0"
   },
   "peerDependencies": {
-    "keyv": "^5.6.0"
+    "keyv": "^6.0.0-alpha.1"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.3.11",
@@ -55,7 +55,7 @@
     "timekeeper": "^2.3.1",
     "tsd": "^0.33.0",
     "vitest": "^4.0.16",
-    "@keyv/test-suite": "^2.1.2"
+    "@keyv/test-suite": "^6.0.0-alpha.1"
   },
   "tsd": {
     "directory": "test"