About The Project

This project is forked from liaoliaots/nestjs-redis.

Features

• Both redis & cluster are supported: You can also specify multiple instances.
• Health: Checks health of redis & cluster server.
• Rigorously tested: With 100+ tests and 100% code coverage.
• Services: Retrieves redis & cluster clients via RedisManager, ClusterManager.
• Multiple Redis clients: Support for ioredis only.
• Health checks: Dedicated health check module for Redis monitoring.

Test coverage

Statements	Branches	Functions	Lines

Getting Started

Prerequisites

This lib requires Node.js >=16.13.0, NestJS ^10.0.0, ioredis ^5.0.0 or redis ^5.6.0.

• If you depend on ioredis 5 & NestJS 10, please use version 10 of the lib.
• If you depend on ioredis 5 & NestJS 9, please use version 9 of the lib.
• If you depend on ioredis 5, NestJS 7 or 8, please use version 8 of the lib.
• If you depend on ioredis 4, please use version 7 of the lib.

Installation

For ioredis (Recommended)

# with npm
npm install @nestjs-labs/nestjs-ioredis ioredis
# with yarn
yarn add @nestjs-labs/nestjs-ioredis ioredis
# with pnpm
pnpm add @nestjs-labs/nestjs-ioredis ioredis
Copy

For node-redis

# with npm
npm install @nestjs-labs/nestjs-redis redis
# with yarn
yarn add @nestjs-labs/nestjs-redis redis
# with pnpm
pnpm add @nestjs-labs/nestjs-redis redis
Copy

For health checks

# with npm
npm install @nestjs/terminus @nestjs-labs/nestjs-redis-health ioredis
# with yarn
yarn add @nestjs/terminus @nestjs-labs/nestjs-redis-health ioredis
# with pnpm
pnpm add @nestjs/terminus @nestjs-labs/nestjs-redis-health ioredis
Copy

Packages

This monorepo contains three main packages:

1. @nestjs-labs/nestjs-ioredis

Redis(ioredis) module for Nest framework (node.js).

Features:

• Full ioredis support with all features
• Redis cluster support
• Sentinel support
• Multiple instances support
• Comprehensive testing with 100% coverage

Installation:

npm install @nestjs-labs/nestjs-ioredis ioredis
Copy

Quick Start:

import { Module } from '@nestjs/common';
import { RedisModule } from '@nestjs-labs/nestjs-ioredis';

@Module({
  imports: [
    RedisModule.forRoot({
      config: {
        host: 'localhost',
        port: 6379,
        password: 'authpassword'
      }
    }),
  ],
})
export class AppModule {}
Copy

2. @nestjs-labs/nestjs-redis

Redis(node-redis) module for Nest framework (node.js).

Features:

• Official node-redis client support
• Modern Redis client with latest features
• TypeScript support
• Simple and clean API

Installation:

npm install @nestjs-labs/nestjs-redis redis
Copy

Quick Start:

import { Module } from '@nestjs/common';
import { RedisModule } from '@nestjs-labs/nestjs-redis';

@Module({
  imports: [
    RedisModule.forRoot({
      url: 'redis://localhost:6379',
    }),
  ],
})
export class AppModule {}
Copy

3. @nestjs-labs/nestjs-redis-health

Redis health checks module for Nest framework (node.js).

Features:

• Health checks for both Redis and Redis Cluster
• Integration with @nestjs/terminus
• Memory threshold monitoring
• Timeout configuration
• Comprehensive health indicators

Installation:

npm install @nestjs/terminus @nestjs-labs/nestjs-redis-health ioredis
Copy

Quick Start:

import { Module } from '@nestjs/common';
import { TerminusModule } from '@nestjs/terminus';
import { RedisHealthModule } from '@nestjs-labs/nestjs-redis-health';

@Module({
  imports: [TerminusModule, RedisHealthModule],
})
export class AppModule {}
Copy

Usage

• Documentation
• Redis
  • Usage
  • Configuration
  • Testing
  • Non-Global
  • Auto-reconnect
  • Unix domain socket
• Cluster
  • Usage
  • Configuration
  • Testing
  • Non-Global
  • Auto-reconnect
• Health Checks
• Examples
  • Redis Sentinel

Legacy

• version 7, click here
• version 8, click here

FAQs

Circular dependency ⚠️

"Cannot resolve dependency" error

Nest can't resolve dependencies of the <provider> (?). Please make sure that the argument <unknown_token> at index [<index>] is available in the <module> context.

Potential solutions:
- If <unknown_token> is a provider, is it part of the current <module>?
- If <unknown_token> is exported from a separate @Module, is that module imported within <module>?
  @Module({
    imports: [ /* the Module containing <unknown_token> */ ]
  })
Copy

// redis-config.service.ts
import { Injectable } from '@nestjs/common';
import { RedisModuleOptions, RedisOptionsFactory } from '@nestjs-labs/nestjs-ioredis';

@Injectable()
export class RedisConfigService implements RedisOptionsFactory {
  createRedisOptions(): RedisModuleOptions {
    return {
      readyLog: true,
      config: {
        host: 'localhost',
        port: 6379,
        password: 'authpassword'
      }
    };
  }
}
Copy

// app.module.ts
import { Module } from '@nestjs/common';
import { RedisModule } from '@nestjs-labs/nestjs-ioredis';
import { RedisConfigService } from './redis-config.service';

@Module({
  imports: [
    RedisModule.forRootAsync({
      useClass: RedisConfigService
    })
  ]
})
export class AppModule {}
Copy

// my-redis.module.ts
import { Module } from '@nestjs/common';
import { RedisModule } from '@nestjs-labs/nestjs-ioredis';
import { RedisConfigService } from './redis-config.service';

@Module({
  imports: [
    RedisModule.forRootAsync({
      useClass: RedisConfigService
    })
  ]
})
export class MyRedisModule {}
Copy

// app.module.ts
import { Module } from '@nestjs/common';
import { MyRedisModule } from './my-redis.module';

@Module({
  imports: [MyRedisModule]
})
export class AppModule {}
Copy

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgments

• node-redis
• Full-Featured Redis Client - ioredis
• Official Redis Documentation
• Official Redis Docker Image