![\"Nest](\"https://nestjs.com/img/logo-small.svg\"){kind=logo}
\n\n \n
A progressive Node.js framework for building efficient and scalable server-side applications.
\n\n\n## Description\n\nioredis utilities module for nestjs framework\n\n## Installation\n\n```bash\n$ npm i --save @ashu_guo/nest-redis\n```\n\n## Usage\n\nImport `RedisModule`:\n\n```typescript\nimport {RedisModule} from '@ashu_guo/nest-redis';\n\n@Module({\n imports: [RedisModule.register({\n host: 'localhost',\n port: 6379,\n username: 'xxxxx',\n password: '*****',\n })],\n providers: [...],\n})\nexport class UsersModule {\n}\n```\n\nInject `RedisClient`:\n\n```typescript\nimport {InjectRedisClient, RedisClient} from '@ashu_guo/nest-redis';\n\n@Injectable()\nexport class UsersService {\n constructor(@InjectRedisClient() private readonly redisClient: RedisClient) {\n }\n}\n```\n\n## Async options\n\nQuite often you might want to asynchronously pass your module options instead of passing them beforehand. In such case,\nuse `registerAsync()` method, that provides a couple of various ways to deal with async data.\n\n**1. Use factory**\n\n```typescript\n@Module({\n imports: [\n RedisModule.registerAsync({\n useFactory: () => ({\n host: 'localhost',\n port: 6379,\n username: 'xxxxx',\n password: '*****',\n })\n })\n ]\n})\n\nexport class AppModule {\n}\n\n```\n\nObviously, our factory behaves like every other one (might be `async` and is able to inject dependencies\nthrough `inject`).\n\n```typescript\nRedisModule.registerAsync({\n imports: [ConfigModule],\n useFactory: async (configService: ConfigService) => ({\n host: configService.get