{"_id":"@dvantage/nestjs-redis","_rev":"5-ba6bd45a8fc407ab8e27dafedd53cbbd","name":"@dvantage/nestjs-redis","dist-tags":{"latest":"0.0.3"},"versions":{"10.1.0":{"name":"@dvantage/nestjs-redis","version":"10.1.0","keywords":["redis","ioredis","sentinel","cluster","nestjs","nest","nodejs","node","typescript","javascript"],"author":{"name":"LiaoLiao","email":"yxiaosong002@gmail.com"},"license":"MIT","_id":"@dvantage/nestjs-redis@10.1.0","maintainers":[{"name":"dvantage","email":"i@d-vantage.com"}],"homepage":"https://github.com/liaoliaots/nestjs-redis#readme","bugs":{"url":"https://github.com/liaoliaots/nestjs-redis/issues"},"dist":{"shasum":"55ebe05b617ccbf52626fd84d63d2edf07b36a9c","tarball":"https://registry.npmjs.org/@dvantage/nestjs-redis/-/nestjs-redis-10.1.0.tgz","fileCount":67,"integrity":"sha512-d2AK7eL7igWxNEy/+fxJ+ttymM3xKNSU4OReTphhh2hU04RNGSt9yvk8vjP48lwD+ZCjdbJeu3azj8IMX4cjbA==","signatures":[{"sig":"MEQCIDkolwQw0AD81vSjnWyv3y8l6On7+jCAQQ7gQt/msUuPAiBr/ut4YCji0wuCYN//D9g88OHzDnxjkr/rUldZbA4Agg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":55298},"main":"./dist/index.js","type":"commonjs","types":"./dist/index.d.ts","engines":{"node":">=16"},"exports":"./dist/index.js","gitHead":"f902b3dc904bf04e8b1f535789decfe11c1c5c37","scripts":{"lint":"concurrently \"npm:lint:es\" \"npm:lint:tsc\"","test":"jest","build":"tsc --project tsconfig.build.json && tsc-alias -p tsconfig.build.json","madge":"madge --image dependencies.svg dist/index.js","badges":"istanbul-badges-readme --coverageDir=\"./coverage\" --readmeDir=\"./\" --style=\"flat-square\" --logo=\"jest\"","lint:es":"eslint \"{lib,test}/**/*.ts\"","lint:tsc":"tsc --project tsconfig.json --noEmit","prebuild":"rimraf dist","test:cov":"jest --coverage","test:e2e":"jest --config ./test/jest-e2e.json","publish:rc":"npm publish --tag rc","test:clear":"jest --clearCache","test:watch":"jest --watch","publish:alpha":"npm publish --tag alpha"},"_npmUser":{"name":"dvantage","email":"i@d-vantage.com"},"repository":{"url":"git+https://github.com/liaoliaots/nestjs-redis.git","type":"git"},"_npmVersion":"10.9.3","description":"Redis(ioredis) module for Nest framework (node.js).","directories":{},"_nodeVersion":"22.20.0","dependencies":{"tslib":"2.8.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"peerDependencies":{"ioredis":"^5.8.1","@nestjs/core":"^11.1.6","@nestjs/common":"^11.1.6"},"_npmOperationalInternal":{"tmp":"tmp/nestjs-redis_10.1.0_1759908329590_0.5695772217769768","host":"s3://npm-registry-packages-npm-production"}},"0.0.1":{"name":"@dvantage/nestjs-redis","version":"0.0.1","keywords":["redis","redis","sentinel","cluster","nestjs","nest","nodejs","node","typescript","javascript"],"author":{"name":"LiaoLiao","email":"yxiaosong002@gmail.com"},"license":"MIT","_id":"@dvantage/nestjs-redis@0.0.1","maintainers":[{"name":"dvantage","email":"i@d-vantage.com"}],"homepage":"https://github.com/liaoliaots/nestjs-redis#readme","bugs":{"url":"https://github.com/liaoliaots/nestjs-redis/issues"},"dist":{"shasum":"a4a124710401334304544c596c660da392adf717","tarball":"https://registry.npmjs.org/@dvantage/nestjs-redis/-/nestjs-redis-0.0.1.tgz","fileCount":67,"integrity":"sha512-cDhZMp84FmWIFPm2fIKhLXOsg3/KRwVHPS0qfrE+ZhaRLHlKEBd2bVOESxczQNEOdHEU9eE0YIOqM/r5RqXJfg==","signatures":[{"sig":"MEUCIQCMirPUFSrh+dlYdEsTSwU9xJo95Jay1o5WoGCkjdGO2AIgJQd+t0Jj8LRZW//FKaTu9C8A7WedbFYn47BYMo+Bs98=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":61335},"main":"./dist/index.js","type":"commonjs","types":"./dist/index.d.ts","engines":{"node":">=16"},"exports":"./dist/index.js","gitHead":"7b3b02e09059ef11ca9e410babc3dce597b8edd6","scripts":{"lint":"concurrently \"npm:lint:es\" \"npm:lint:tsc\"","test":"jest","build":"tsc --project tsconfig.build.json && tsc-alias -p tsconfig.build.json","madge":"madge --image dependencies.svg dist/index.js","badges":"istanbul-badges-readme --coverageDir=\"./coverage\" --readmeDir=\"./\" --style=\"flat-square\" --logo=\"jest\"","lint:es":"eslint \"lib/**/*.ts\"","lint:tsc":"tsc --project tsconfig.json --noEmit","prebuild":"rimraf dist","test:cov":"jest --coverage","test:e2e":"jest --config ./test/jest-e2e.json","publish:rc":"npm publish --tag rc","test:clear":"jest --clearCache","test:watch":"jest --watch","publish:alpha":"npm publish --tag alpha"},"_npmUser":{"name":"dvantage","email":"i@d-vantage.com"},"repository":{"url":"git+https://github.com/liaoliaots/nestjs-redis.git","type":"git"},"_npmVersion":"10.9.3","description":"Redis(official client) module for Nest framework (node.js).","directories":{},"_nodeVersion":"22.20.0","dependencies":{"tslib":"2.8.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"peerDependencies":{"redis":"^5.8.3","@nestjs/core":"^11.1.6","@nestjs/common":"^11.1.6"},"_npmOperationalInternal":{"tmp":"tmp/nestjs-redis_0.0.1_1759923353957_0.510516652457154","host":"s3://npm-registry-packages-npm-production"}},"0.0.3":{"name":"@dvantage/nestjs-redis","version":"0.0.3","description":"Redis(official client) module for Nest framework (node.js).","author":{"name":"LiaoLiao","email":"yxiaosong002@gmail.com"},"exports":"./dist/index.js","main":"./dist/index.js","types":"./dist/index.d.ts","type":"commonjs","license":"MIT","keywords":["redis","redis","sentinel","cluster","nestjs","nest","nodejs","node","typescript","javascript"],"scripts":{"prebuild":"rimraf dist","build":"tsc --project tsconfig.build.json && tsc-alias -p tsconfig.build.json","lint":"concurrently \"npm:lint:es\" \"npm:lint:tsc\"","lint:es":"eslint \"lib/**/*.ts\"","lint:tsc":"tsc --project tsconfig.json --noEmit","test":"jest","test:watch":"jest --watch","test:cov":"jest --coverage","test:e2e":"jest --config ./test/jest-e2e.json","test:clear":"jest --clearCache","badges":"istanbul-badges-readme --coverageDir=\"./coverage\" --readmeDir=\"./\" --style=\"flat-square\" --logo=\"jest\"","madge":"madge --image dependencies.svg dist/index.js","publish:alpha":"npm publish --tag alpha","publish:rc":"npm publish --tag rc"},"dependencies":{"tslib":"2.8.1"},"peerDependencies":{"@nestjs/common":"^11.1.6","@nestjs/core":"^11.1.6","redis":"^5.9.0"},"engines":{"node":">=16"},"publishConfig":{"access":"public"},"homepage":"https://github.com/liaoliaots/nestjs-redis#readme","repository":{"type":"git","url":"git+https://github.com/liaoliaots/nestjs-redis.git"},"bugs":{"url":"https://github.com/liaoliaots/nestjs-redis/issues"},"gitHead":"0c7cc8ff36ebd69e33453438103334f44df34ce9","_id":"@dvantage/nestjs-redis@0.0.3","_nodeVersion":"24.11.0","_npmVersion":"11.6.1","dist":{"integrity":"sha512-7yAEEAPgmJ08WXG04zb7qwL4gGoO9TIRY7CEEHfhVKneeSCyFtb4NpsDb5kjUXZM5mu7FSApbfWrMXQVH4vuFQ==","shasum":"a346f5d7e47fe70203ad5b0dacee38c65fc6a7d1","tarball":"https://registry.npmjs.org/@dvantage/nestjs-redis/-/nestjs-redis-0.0.3.tgz","fileCount":67,"unpackedSize":61405,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCZ3VyHfD/U3UYwSrOB+EeyHqaKW8OJ7J3VveUYfCVTEgIgcqgSsuiE+5Ew3iv9WNQDxZw+9P+i1cgkfWyNP9N6sJg="}]},"_npmUser":{"name":"dvantage","email":"i@d-vantage.com"},"directories":{},"maintainers":[{"name":"dvantage","email":"i@d-vantage.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/nestjs-redis_0.0.3_1762857176862_0.3987168043235616"},"_hasShrinkwrap":false}},"time":{"created":"2025-10-08T07:25:29.168Z","modified":"2025-11-11T10:32:57.310Z","10.1.0":"2025-10-08T07:25:29.795Z","0.0.1":"2025-10-08T11:35:54.142Z","0.0.2":"2025-11-11T10:28:03.098Z","0.0.3":"2025-11-11T10:32:57.103Z"},"bugs":{"url":"https://github.com/liaoliaots/nestjs-redis/issues"},"author":{"name":"LiaoLiao","email":"yxiaosong002@gmail.com"},"license":"MIT","homepage":"https://github.com/liaoliaots/nestjs-redis#readme","keywords":["redis","redis","sentinel","cluster","nestjs","nest","nodejs","node","typescript","javascript"],"repository":{"type":"git","url":"git+https://github.com/liaoliaots/nestjs-redis.git"},"description":"Redis(official client) module for Nest framework (node.js).","maintainers":[{"name":"dvantage","email":"i@d-vantage.com"}],"readme":"![NPM Version](https://img.shields.io/npm/v/%40liaoliaots%2Fnestjs-redis%2Falpha?style=for-the-badge)\n[![Downloads][downloads-shield]][downloads-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![License][license-shield]][license-url]\n\n

\n \n \"Nest\n \n

\n\n
\n

Nest Redis Module

\n\n

\n Redis (official node client) module for Nest framework (node.js).\n
\n Explore the docs »\n
\n
\n View Demos\n ·\n Report Bug\n ·\n Request Feature\n

\n
\n\n
\n Table of Contents\n
    \n
  1. \n About The Project\n \n
    2. \n
  2. \n Getting Started\n \n
    3. \n
  3. Usage
    4. \n
  4. FAQs
    5. \n
  5. Roadmap
    6. \n
  6. Contributing
    7. \n
  7. License
    8. \n
  8. Acknowledgments
    9. \n
\n
\n\n## About The Project\n\n### Features\n\n- **Both redis & cluster are supported**: You can also specify multiple instances.\n- **Health**: Checks health of **redis & cluster** server.\n- **Rigorously tested**: With 100+ tests and 100% code coverage.\n- **Services**: Retrieves **redis & cluster** connection via `RedisService`, `ClusterService`.\n\n### Test coverage\n\n| Statements | Branches | Functions | Lines |\n| --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |\n| ![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) |\n\n## Getting Started\n\n### Prerequisites\n\nThis lib requires **Node.js >=20.0.0**, **NestJS ^10.0.0**, **redis ^5.9.0**.\n\n### Installation\n\n```sh\n# with npm\nnpm install @liaoliaots/nestjs-redis redis\n# with yarn\nyarn add @liaoliaots/nestjs-redis redis\n# with pnpm\npnpm add @liaoliaots/nestjs-redis redis\n```\n\n## Usage\n\n- [Redis](/docs/latest/redis.md)\n - [Usage](/docs/latest/redis.md)\n - [Configuration](/docs/latest/redis.md#configuration)\n - [Testing](/docs/latest/redis.md#testing)\n - [Non-Global](/docs/latest/redis.md#non-global)\n - [Client configuration](https://redis.io/docs/latest/develop/reference/clients/nodejs/)\n - [Unix domain socket](/docs/latest/redis.md#unix-domain-socket)\n- [Cluster](/docs/latest/cluster.md)\n - [Usage](/docs/latest/cluster.md)\n - [Configuration](/docs/latest/cluster.md#configuration)\n - [Testing](/docs/latest/cluster.md#testing)\n - [Non-Global](/docs/latest/cluster.md#non-global)\n - [Cluster configuration](https://redis.io/docs/latest/develop/reference/clients/nodejs/)\n- [Health Checks](/packages/redis-health/README.md)\n- [Examples](/docs/latest/examples.md)\n - [Redis Sentinel](/docs/latest/examples.md#sentinel)\n\n### Legacy\n\n- version 9, [click here](/docs/v9)\n- version 8, [click here](/docs/v8)\n- version 7, [click here](/docs/v7)\n\n## FAQs\n\n### Circular dependency ⚠️\n\n
\n Click to expand\n\n[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).\n\n
\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf 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\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n## Acknowledgments\n\n- [Official Redis Documentation](https://redis.io/)\n- [Official Redis Docker Image](https://hub.docker.com/_/redis)\n\n[downloads-shield]: https://img.shields.io/npm/dm/@liaoliaots/nestjs-redis?style=for-the-badge\n[downloads-url]: https://www.npmjs.com/package/@liaoliaots/nestjs-redis\n[stars-shield]: https://img.shields.io/github/stars/liaoliaots/nestjs-redis?style=for-the-badge\n[stars-url]: https://github.com/liaoliaots/nestjs-redis/stargazers\n[issues-shield]: https://img.shields.io/github/issues/liaoliaots/nestjs-redis?style=for-the-badge\n[issues-url]: https://github.com/liaoliaots/nestjs-redis/issues\n[license-shield]: https://img.shields.io/npm/l/@liaoliaots/nestjs-redis?style=for-the-badge\n[license-url]: https://github.com/liaoliaots/nestjs-redis/blob/main/LICENSE\n","readmeFilename":"README.md"}