# @liaoliaots/nestjs-redis > Redis(ioredis) module for Nest framework (node.js). Latest version **10.0.0** (published 2024-09-25) · MIT license · 0 weekly downloads ## Install ```sh npm install @liaoliaots/nestjs-redis pnpm add @liaoliaots/nestjs-redis yarn add @liaoliaots/nestjs-redis bun add @liaoliaots/nestjs-redis ``` ## Health **Score 35/100 (D)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 10.0.0 | | Published | 2024-09-25 | | First published | 2021-06-20 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=16.13.0 | | Dependencies | 1 | | Unpacked size | 50.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 438 | | Author | LiaoLiao | | Maintainers | liaoliaots | | Keywords | redis, ioredis, sentinel, cluster, nestjs, nest, nodejs, node, typescript, javascript | ## Links - npm: https://www.npmjs.com/package/@liaoliaots/nestjs-redis - Repository: https://github.com/liaoliaots/nestjs-redis - Homepage: https://github.com/liaoliaots/nestjs-redis#readme - Issues: https://github.com/liaoliaots/nestjs-redis/issues - npm.io page: https://npm.io/package/@liaoliaots/nestjs-redis ## Dependencies (1) - [tslib](https://npm.io/package/tslib.md) 2.7.0 ## Alternatives - [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads - [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads - [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads - [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads - [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads ## Recent versions - 10.0.0 (latest) — 2024-09-25 - 10.0.0-alpha.3 (alpha) — 2024-09-22 - 9.1.0-next.2 (next) — 2022-08-31 - 7.0.0-rc.3 (rc) — 2022-03-13 - 10.0.0-alpha.2 — 2024-09-21 - 10.0.0-alpha.1 — 2024-09-21 - 9.0.5 — 2023-01-01 - 9.0.4 — 2022-11-06 - 9.0.3 — 2022-10-01 - 9.0.2 — 2022-09-01 - 9.1.0-next.1 — 2022-08-31 - 9.0.1 — 2022-07-20 - 9.0.0 — 2022-07-17 - 9.0.0-next.1 — 2022-07-12 - 8.2.2 — 2022-06-24 - … 36 more at https://npm.io/package/@liaoliaots/nestjs-redis/versions ## README ![NPM Version](https://img.shields.io/npm/v/%40liaoliaots%2Fnestjs-redis%2Falpha?style=for-the-badge) [![Downloads][downloads-shield]][downloads-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![License][license-shield]][license-url]

Nest Logo

Nest Redis Module

Redis(ioredis) 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 - **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** connection via `RedisService`, `ClusterService`. ### Test coverage | Statements | Branches | Functions | Lines | | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | ![Statements](https://img.shields.io/badge/statements-100%25-brightgreen.svg?style=flat-square&logo=jest) | ![Branches](https://img.shields.io/badge/branches-100%25-brightgreen.svg?style=flat-square&logo=jest) | ![Functions](https://img.shields.io/badge/functions-100%25-brightgreen.svg?style=flat-square&logo=jest) | ![Lines](https://img.shields.io/badge/lines-100%25-brightgreen.svg?style=flat-square&logo=jest) | ## Getting Started ### Prerequisites This lib requires **Node.js >=16.13.0**, **NestJS ^10.0.0**, **ioredis ^5.0.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](https://github.com/liaoliaots/nestjs-redis/tree/v8.2.2) of the lib. - If you depend on **ioredis 4**, please use [version 7](https://github.com/liaoliaots/nestjs-redis/tree/v7.0.0) of the lib. ### Installation ```sh # 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 - [Redis](/docs/latest/redis.md) - [Usage](/docs/latest/redis.md) - [Configuration](/docs/latest/redis.md#configuration) - [Testing](/docs/latest/redis.md#testing) - [Non-Global](/docs/latest/redis.md#non-global) - [Auto-reconnect](https://luin.github.io/ioredis/interfaces/CommonRedisOptions.html#retryStrategy) - [Unix domain socket](/docs/latest/redis.md#unix-domain-socket) - [Cluster](/docs/latest/cluster.md) - [Usage](/docs/latest/cluster.md) - [Configuration](/docs/latest/cluster.md#configuration) - [Testing](/docs/latest/cluster.md#testing) - [Non-Global](/docs/latest/cluster.md#non-global) - [Auto-reconnect](https://luin.github.io/ioredis/interfaces/ClusterOptions.html#clusterRetryStrategy) - [Health Checks](/packages/redis-health/README.md) - [Examples](/docs/latest/examples.md) - [Redis Sentinel](/docs/latest/examples.md#sentinel) ### Legacy - version 9, [click here](/docs/v9) - version 8, [click here](/docs/v8) - version 7, [click here](/docs/v7) ## 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).
## 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 - [Full-Featured Redis Client - ioredis](https://github.com/luin/ioredis) - [Official Redis Documentation](https://redis.io/) - [Official Redis Docker Image](https://hub.docker.com/_/redis) [downloads-shield]: https://img.shields.io/npm/dm/@liaoliaots/nestjs-redis?style=for-the-badge [downloads-url]: https://www.npmjs.com/package/@liaoliaots/nestjs-redis [stars-shield]: https://img.shields.io/github/stars/liaoliaots/nestjs-redis?style=for-the-badge [stars-url]: https://github.com/liaoliaots/nestjs-redis/stargazers [issues-shield]: https://img.shields.io/github/issues/liaoliaots/nestjs-redis?style=for-the-badge [issues-url]: https://github.com/liaoliaots/nestjs-redis/issues [license-shield]: https://img.shields.io/npm/l/@liaoliaots/nestjs-redis?style=for-the-badge [license-url]: https://github.com/liaoliaots/nestjs-redis/blob/main/LICENSE --- _Source: https://npm.io/package/@liaoliaots/nestjs-redis · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._