search

liaoliaots / nestjs-redis

Redis module for Nest framework (node.js). Support node-redis & ioredis.
MIT License
392 stars 71 forks source link
cluster healthchecks ioredis javascript nest nestjs node node-redis nodejs redis sentinel typescript

readme

NPM Version Downloads Stargazers Issues License

Nest Logo

Nest Redis Module

Redis(ioredis & node-redis) module for Nest framework (node.js).
Explore the docs »

View Demos · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. FAQs
  5. Roadmap
  6. Contributing
  7. License
  8. Acknowledgments

About The Project

Features

Test coverage

Statements Branches Functions Lines
Statements Branches Functions Lines

Getting Started

Prerequisites

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

Node-Redis

If you prefre node-redis, check out [this guide](), but it is in working progress.

Installation

# with npm
npm install @liaoliaots/nestjs-redis ioredis
# with yarn
yarn add @liaoliaots/nestjs-redis ioredis
# with pnpm
pnpm add @liaoliaots/nestjs-redis ioredis

Usage

Legacy

FAQs

Circular dependency ⚠️

Click to expand [A circular dependency](https://docs.nestjs.com/fundamentals/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.controller` should not import `cats` to import the `cats/cats.service` file. For more details please also see [this github issue](https://github.com/nestjs/nest/issues/1181#issuecomment-430197191).

"Cannot resolve dependency" error

Click to expand If you encountered an error like this: ``` Nest can't resolve dependencies of the (?). Please make sure that the argument at index [] is available in the context. Potential solutions: - If is a provider, is it part of the current ? - If is exported from a separate @Module, is that module imported within ? @Module({ imports: [ /* the Module containing */ ] }) ``` 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: ```ts // 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' } }; } } ``` ### ✅ Correct ```ts // 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 {} ``` ### ❌ Incorrect ```ts // 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 {} ``` ```ts // app.module.ts import { Module } from '@nestjs/common'; import { MyRedisModule } from './my-redis.module'; @Module({ imports: [MyRedisModule] }) export class AppModule {} ```

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