Yuuki-Sakura/nestjs-redis

Redis(ioredis) module for NestJS framework

Redis(ioredis) module for NestJS framework.

Features 🚀

• Support redis and cluster
• Support health check
• Support multiple clients
• Inject a redis/cluster client via @InjectRedis() and @InjectCluster()
• Get a redis/cluster client via RedisManager and ClusterManager

Documentation

• Test coverage
• Install
• Redis
• Cluster
• Health Checks
• Examples
  • Redis Sentinel
  • Multiple Cluster Clients
• Distributed locks
• Test a class
• Package dependency overview
• TODO

legacy V2 and V3@next, click here.

legacy V3, click here.

legacy V4, click here.

Test coverage

Statements	Branches	Functions	Lines

Install

This package supports both nestjs 7.x and 8.x.

$ npm install --save @liaoliaots/nestjs-redis ioredis
$ npm install --save-dev @types/ioredis

$ yarn add @liaoliaots/nestjs-redis ioredis
$ yarn add --dev @types/ioredis

Distributed locks

• redlock
• simple-redis-mutex
• nestjs-simple-redis-lock

Test a class

This package exports getRedisToken() and getClusterToken() functions that return an internal injection token based on the provided context. Using this token, you can provide a mock implementation of the redis/cluster client using any of the standard custom provider techniques, including useClass, useValue, and useFactory.

const module: TestingModule = await Test.createTestingModule({
    providers: [{ provide: getRedisToken('your namespace'), useValue: mockClient }, YourService]
}).compile();

A working example is available here.

TODO

1. • COMMAND: SELECT

Author

👤 LiaoLiao

• Github: @liaoliaots

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

This project is MIT licensed.

Package dependency overview