---

Features

- Plug-and-play Terminus health checks
- Works with existing @nestjs-redis/client connections
- Supports multiple Redis instances
- Type-safe, production-ready

Installation

``bash
npm install @nestjs-redis/health-indicator @nestjs-redis/client redis
`

The recommended approach is to use RedisModule from @nestjs-redis/client so Redis connections are lifecycle-managed by Nest (connect/disconnect with your app). Alternatively, you can pass your own Redis client (e.g. created with createClient() from redis) and manage its lifecycle yourself.

Quick Start

`typescript
// app.module.ts
import { Module } from '@nestjs/common';
import { TerminusModule } from '@nestjs/terminus';
import { RedisModule } from '@nestjs-redis/client';
import { RedisHealthIndicator } from '@nestjs-redis/health-indicator';

@Module({
imports: [
RedisModule.forRoot({
type: 'client',
options: { url: 'redis://localhost:6379' },
}),
TerminusModule,
],
providers: [RedisHealthIndicator],
})
export class AppModule {}
`

`typescript
// health.controller.ts
import { Controller, Get } from '@nestjs/common';
import { HealthCheck, HealthCheckService } from '@nestjs/terminus';
import { InjectRedis } from '@nestjs-redis/client';
import { RedisHealthIndicator } from '@nestjs-redis/health-indicator';
import type { RedisClientType } from 'redis';

@Controller('health')
export class HealthController {
constructor(
private readonly health: HealthCheckService,
private readonly redis: RedisHealthIndicator,
@InjectRedis() private readonly redisClient: RedisClientType,
) {}

@Get()
@HealthCheck()
check() {
return this.health.check([
() => this.redis.isHealthy('redis', { client: this.redisClient }),
]);
}
}
`

$3

`typescript
@Controller('health')
export class HealthController {
constructor(
private readonly health: HealthCheckService,
private readonly redis: RedisHealthIndicator,
@InjectRedis() private readonly mainRedis: RedisClientType,
@InjectRedis('cache') private readonly cacheRedis: RedisClientType,
) {}

@Get()
@HealthCheck()
check() {
return this.health.check([
() => this.redis.isHealthy('redis-main', { client: this.mainRedis }),
() => this.redis.isHealthy('redis-cache', { client: this.cacheRedis }),
]);
}
}
``

Links

- Root repo: CSenshi/nestjs-redis
- Issues: GitHub Issues
- Discussions: GitHub Discussions

Contributing

Please see the root contributing guidelines.

License

MIT © CSenshi