Welcome to nestjs-redis 👋

Redis(ioredis) module for NestJS framework

Features

• Supports redis and cluster
• Supports health check
• Supports specify single or multiple clients
• Supports inject a client directly or get a client via namespace

Documentation

• Test coverage
• Install
• Redis
  • Usage
  • Health check
  • Options
• Cluster
  • Usage
  • Health check
  • Options
• Examples
  • Redis
    • default
    • sentinel
  • Cluster
• Package dependency overview

Test coverage

Statements	Branches	Functions	Lines

Install

NestJS 8:

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

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

NestJS 7:

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

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

Package dependency overview

Author

👤 LiaoLiao

• Website: https://github.com/liaoliaots
• 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

Copyright © 2021 LiaoLiao.

This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator