Zero-dependency storage adapter for Keyv that works with many different Redis clients and supports cluster mode
This adapter does more than the official @keyv/redis adapter. This adapter can be used with Redis cluster mode — the official adapter cannot. Of course it can also be used with standard, non-cluster, Redis servers.
This adapter also works with many Redis clients, whereas the official adapter bundles a specific version of ioredis.
- ✅ Works with standard Redis servers
- ✅ Works Redis cluster servers
- ✅ Works with ioredis and many other Redis clients
- ✅ Passes all tests in the Keyv test suite
keyv-anyredis works with any Redis client that implements a standard callback or Promise interface, including the two most popular clients, ioredis and node-redis.
We test with the the Keyv test suite, and we test with both a standard Redis server and a Redis cluster. If you are familiar with Redis cluster, you may know that many utlities that claim to be compatible with clusters, are not. keyv-anyredis really is compatible and is tested against a cluster running in a Docker container.
| Client | Compatible? | Notes |
|---|---|---|
| redis | ✅ Yes | Also known as node-redis; works with version 3 and the new version 4, which adds support for cluster mode; works in Promise mode or legacy callback mode |
| ioredis | ✅ Yes | Works great in standard and cluster mode |
| fakeredis | ✅ Yes | |
| fast-redis-cluster2 | ✅ Yes | Cluster mode |
| handy-redis | ✅ Yes | To use this client, pass client.nodeRedis to the KeyvAnyRedis constructor |
| noderis | ⛔️ No | smembers is missing |
| redis-clustr | ✅ Yes | Cluster mode |
| tedis | ✅ Yes | To use this client, cast the client to CompatibleRedisClient in TypeScript |
| thunk-redis | ✅ Yes | Set usePromise: true; works in standard and cluster mode |
| xredis | ✅ Yes |
npm i keyv-anyredisconst Keyv = require('keyv');
const { KeyvAnyRedis } = require('keyv-anyredis');
// Create a client here, using ioredis, redis, or any
// compatible library.
//
// For example, to create a cluster client using ioredis as
// described at https://github.com/luin/ioredis#cluster:
//
// const Redis = require('ioredis');
// const client = new Redis.Cluster(…cluster configuration…);
const store = new KeyvAnyRedis(client);
const keyv = new Keyv({ store });To run the unit tets, Docker must be running. Containers for Redis and Redis Cluster will be started so that tests can run against them.
npm run test:docker