README
keyv-anyredis
Zero-dependency storage adapter for Keyv that works with many different Redis clients and supports cluster mode
Why use this?
Why use this instead of the official @keyv/redis adapter? Because it does more. In particular, it can be used with Redis cluster mode (the official adapter cannot).
- ✅ Works with standard Redis (non-cluster) mode
- ✅ Works with Redis cluster mode
- ✅ Works with ioredis and many other Redis clients
- ✅ Passes all tests in the Keyv test suite
Tested clients
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 use the the official Keyv test suite, and we test with both a standard Redis server and a Redis cluster.
Client | Compatible? | Notes |
---|---|---|
redis | ✅ Yes | Also known as node-redis |
ioredis | ✅ Yes | Works great in standard and cluster mode |
fakeredis | ✅ Yes | |
fast-redis-cluster2 | ✅ Yes | Cluster mode |
handy-redis | ✅ Yes | |
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 |
Install
npm i keyv-anyredis
Usage
const 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 });
Running tests
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