Welcome to @liaoliaots/nestjs-redis 👋
[](https://www.npmjs.com/package/@liaoliaots/nestjs-redis)
[](https://www.npmjs.com/package/@liaoliaots/nestjs-redis/v/3.0.0-next.3)
[](https://github.com/liaoliaots/nestjs-redis/blob/main/LICENSE)
[](https://github.com/prettier/prettier)
[](https://www.codefactor.io/repository/github/liaoliaots/nestjs-redis)
[](https://conventionalcommits.org)
[](https://github.com/liaoliaots/nestjs-redis/graphs/commit-activity)
[](https://github.com/liaoliaots/nestjs-redis/actions/workflows/release.yml)
[](https://github.com/liaoliaots/nestjs-redis/actions/workflows/unit-testing.yml)
> Redis([ioredis](https://github.com/luin/ioredis)) module for NestJS framework.
## Features 🚀
- Support **redis** and **cluster**
- Support health check
- Specify single or multiple clients
- Inject a redis/cluster client via `@InjectRedis()` and `@InjectCluster()` decorator
- Get a redis/cluster client via `RedisService` and `ClusterService`
- Easy to test via `getRedisToken()` and `getClusterToken()`
## Documentation
_For the legacy V2 or V3@next documentation, [click here](docs/v2/README.md)._
- [Test coverage](#test-coverage)
- [Install](#install)
- [Redis](docs/v3/redis.md)
- [Usage](docs/v3/redis.md#usage)
- [Configuration](docs/v3/redis.md#configuration)
- [Cluster](docs/v3/cluster.md)
- [Usage](docs/v3/cluster.md#usage)
- [Configuration](docs/v3/cluster.md#configuration)
- [Health Checks](docs/v3/health-checks.md)
- [Examples](docs/v3/examples.md)
- [Redis](docs/v3/examples.md#redis)
- [Default](docs/v3/examples.md#default)
- [Sentinel](docs/v3/examples.md#sentinel)
- [Cluster](docs/v3/examples.md#cluster)
- [Multiple Clients](docs/v3/examples.md#multiple-clients)
- [Test a class](#test-a-class)
- [Package dependency overview](#package-dependency-overview)
## Test coverage
| Statements | Branches | Functions | Lines |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------- |
|  |  |  |  |
## Install
### NestJS 8:
```sh
$ npm install --save @liaoliaots/nestjs-redis ioredis
$ npm install --save-dev @types/ioredis
```
```sh
$ yarn add @liaoliaots/nestjs-redis ioredis
$ yarn add --dev @types/ioredis
```
### NestJS 7:
```sh
$ npm install --save @liaoliaots/nestjs-redis@2 ioredis @nestjs/terminus@7
$ npm install --save-dev @types/ioredis
```
```sh
$ yarn add @liaoliaots/nestjs-redis@2 ioredis @nestjs/terminus@7
$ yarn add --dev @types/ioredis
```
## 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`.
### Redis
```TypeScript
const module: TestingModule = await Test.createTestingModule({
providers: [{ provide: getRedisToken('namespace'), useValue: mockClient }, YourService]
}).compile();
```
### Cluster
```TypeScript
const module: TestingModule = await Test.createTestingModule({
providers: [{ provide: getClusterToken('namespace'), useValue: mockClient }, YourService]
}).compile();
```
## TODO
- [ ] select db
## Package dependency overview
## Author
👤 **LiaoLiao**
- Github: [@liaoliaots](https://github.com/liaoliaots)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/liaoliaots/nestjs-redis/issues).
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2021 [LiaoLiao](https://github.com/liaoliaots).
This project is [MIT](https://github.com/liaoliaots/nestjs-redis/blob/main/LICENSE) licensed.