Redis(ioredis) module for Nest framework (node.js).
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
- 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.
- Decorators: Injects redis & cluster clients via
@InjectRedis(),@InjectCluster(). - Services: Retrieves redis & cluster clients via
RedisService,ClusterService. - Testing: Generates an injection token via
getRedisToken,getClusterToken.
| Statements | Branches | Functions | Lines |
|---|---|---|---|
 |
 |
 |
 |
This lib requires Node.js >=12.22.0, NestJS ^9.0.0, ioredis ^5.0.0.
- If you depend on ioredis 4, please use version 7 of the lib.
- If you depend on ioredis 5, NestJS 7 or 8, please use version 8 of the lib.
# with npm
npm install @liaoliaots/nestjs-redis ioredis
# with yarn
yarn add @liaoliaots/nestjs-redis ioredis
# with pnpm
pnpm add @liaoliaots/nestjs-redis ioredis- version 7, click here
- version 8, click here
WARNING: A circular dependency might also be caused when using "barrel files"/index.ts files to group imports. Barrel files should be omitted when it comes to module/provider classes. For example, barrel files should not be used when importing files within the same directory as the barrel file, i.e.
cats/cats.controllershould not importcatsto import thecats/cats.servicefile. For more details please also see this github issue.
Click to expand
If you encountered an error like this:
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> */ ]
})
Please make sure that the RedisModule is added directly to the imports array of @Module() decorator of "Root Module"(if isGlobal is true) or "Feature Module"(if isGlobal is false).
Examples of code:
// redis-config.service.ts
import { Injectable } from '@nestjs/common';
import { RedisModuleOptions, RedisOptionsFactory } from '@liaoliaots/nestjs-redis';
@Injectable()
export class RedisConfigService implements RedisOptionsFactory {
createRedisOptions(): RedisModuleOptions {
return {
readyLog: true,
config: {
host: 'localhost',
port: 6379,
password: 'authpassword'
}
};
}
}// app.module.ts
import { Module } from '@nestjs/common';
import { RedisModule } from '@liaoliaots/nestjs-redis';
import { RedisConfigService } from './redis-config.service';
@Module({
imports: [
RedisModule.forRootAsync({
useClass: RedisConfigService
})
]
})
export class AppModule {}// my-redis.module.ts
import { Module } from '@nestjs/common';
import { RedisModule } from '@liaoliaots/nestjs-redis';
import { RedisConfigService } from './redis-config.service';
@Module({
imports: [
RedisModule.forRootAsync({
useClass: RedisConfigService
})
]
})
export class MyRedisModule {}// app.module.ts
import { Module } from '@nestjs/common';
import { MyRedisModule } from './my-redis.module';
@Module({
imports: [MyRedisModule]
})
export class AppModule {}- Compatible with NestJS ^9
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.