fix: correct the use of the redis health indicator

README.md

@@ -92,6 +92,49 @@ export class AppController {
 }
 ```
 
+#### How to use the Redis indicator for the Terminus library?"
+
+```js
+//health.module.ts
+import { Module } from '@nestjs/common';
+import { TerminusModule } from '@nestjs/terminus';
+import { RedisHealthModule, RedisHealthIndicator, } from '@nestjs-modules/ioredis';
+
+@Module({
+  imports: [TerminusModule, RedisHealthModule],
+  controllers: [HealthController],
+  providers: [RedisHealthIndicator]
+})
+export class HealthModule {}
+```
+
+```js
+//health.indicator.ts
+import { Controller, Get } from '@nestjs/common';
+import {
+  HealthCheckService,
+  HealthCheck,
+  HealthCheckResult
+} from '@nestjs/terminus';
+import { RedisHealthIndicator } from './redis.health';
+
+@Controller('health')
+export class HealthController {
+  constructor(
+    private health: HealthCheckService,
+    private redis: RedisHealthIndicator,
+  ) {}
+
+  @Get()
+  @HealthCheck()
+  check(): Promise<HealthCheckResult> {
+    return this.health.check([
+      async () => this.redis.isHealthy('redis'),
+    ]);
+  }
+}
+```
+
 ## License
 
 MIT

lib/index.ts

@@ -2,4 +2,5 @@ export * from './redis.module';
 export * from './redis.decorators';
 export * from './redis.interfaces';
 export * from './redis.utils';
-export * from './redis.health';
+export * from './indicator/redis-health.indicator';
+export * from './indicator/redis-health.module';

lib/redis.health.ts → lib/indicator/redis-health.indicator.ts

@@ -1,10 +1,12 @@
-import { Injectable } from '@nestjs/common';
+import { Injectable, Inject } from '@nestjs/common';
 import { HealthIndicator, HealthIndicatorResult, HealthCheckError } from '@nestjs/terminus';
 import Redis from 'ioredis';
 
+import { REDIS_HEALTH_INDICATOR } from '../redis.constants';
+
 @Injectable()
 export class RedisHealthIndicator extends HealthIndicator {
-  constructor(private readonly redis: Redis) {
+  constructor(@Inject(REDIS_HEALTH_INDICATOR) private readonly redis: Redis) {
     super();
   }
 

lib/indicator/redis-health.module.ts

@@ -0,0 +1,15 @@
+import { Module } from '@nestjs/common';
+import { TerminusModule } from '@nestjs/terminus';
+//import { HttpModule } from '@nestjs/axios';
+import { RedisHealthIndicator } from './redis-health.indicator';
+import { redisHealthIndicatorProvider } from './redis-health.provider';
+
+@Module({
+  imports: [TerminusModule],
+  providers: [
+    RedisHealthIndicator,
+    redisHealthIndicatorProvider,
+  ],
+  exports: [RedisHealthIndicator]
+})
+export class RedisHealthModule {}

lib/indicator/redis-health.provider.ts

@@ -0,0 +1,7 @@
+import Redis from 'ioredis';
+import { REDIS_HEALTH_INDICATOR } from '../redis.constants';
+
+export const redisHealthIndicatorProvider = {
+  provide: REDIS_HEALTH_INDICATOR,
+  useFactory: () => new Redis(),
+};

lib/redis.constants.ts

@@ -1,3 +1,5 @@
 export const REDIS_MODULE_CONNECTION = 'default';
 export const REDIS_MODULE_CONNECTION_TOKEN = 'IORedisModuleConnectionToken';
 export const REDIS_MODULE_OPTIONS_TOKEN = 'IORedisModuleOptionsToken';
+
+export const REDIS_HEALTH_INDICATOR = 'redisHealthIndicator';