mikro-orm-cache-adapter-redis
v3.3.0
Published
A redis cache adapter for mikro-orm
Downloads
2,417
Readme
Mikro-orm - Redis cache adapter
This is an adapter for redis to be used with mikro-orm.
Install it with its peer dependencies
npm i mikro-orm-cache-adapter-redis ioredis
and pass it as option to mikro-orm
import { MikroORM } from '@mikro-orm/core/MikroORM';
import { RedisCacheAdapter } from 'mikro-orm-cache-adapter-redis';
const orm = await MikroORM.init({
// Your options
resultCache: {
adapter: RedisCacheAdapter,
options: {
// Base options
// An optional key prefix. By default is `mikro`
keyPrefix: 'mikro'
// Optional: print debug informations
debug: false,
// Here goes IORedis connection options (the library will instantiate the client)
host: '...',
port: 6379,
password: 'yourpassword'
}
}
});
Instead of passing options, you can pass directly an IORedis instance
import { RedisCacheAdapter } from "mikro-orm-cache-adapter-redis";
import Redis from "ioredis";
const myRedisClient = new Redis();
const orm = await MikroORM.init({
// Your options
resultCache: {
adapter: RedisCacheAdapter,
options: {
client: myRedisClient,
},
},
});