{"_id":"@songkeys/nestjs-redis","_rev":"3-b5da63229fdb0a4865115c531dc6fa35","name":"@songkeys/nestjs-redis","dist-tags":{"latest":"12.0.0"},"versions":{"10.0.0":{"name":"@songkeys/nestjs-redis","version":"10.0.0","keywords":["redis","ioredis","sentinel","cluster","nestjs","nest","nodejs","node","typescript","javascript"],"author":{"name":"Songkeys","email":"songv587@gmail.com"},"license":"MIT","_id":"@songkeys/nestjs-redis@10.0.0","maintainers":[{"name":"songkeys","email":"i@song.work"}],"homepage":"https://github.com/songkeys/nestjs-redis#readme","bugs":{"url":"https://github.com/songkeys/nestjs-redis/issues"},"dist":{"shasum":"1817acb07e8b9d89449909bfbf9fe9b5c592df91","tarball":"https://registry.npmjs.org/@songkeys/nestjs-redis/-/nestjs-redis-10.0.0.tgz","fileCount":67,"integrity":"sha512-s56+NECuJXzcaPLYzpvA2xjL0e/1Zy55UE0q6b1UqpbQSKI06TFPFCWCMUadJigiuB26O1hxi+lmDbzahKvcLg==","signatures":[{"sig":"MEUCIQC32CW9FF/QrGlw3ZUldmlaMa4EWL00RpEW9TS4pPdt4wIgajQ9p4oL9OFDUEcBB7XXFL4n3zLEpn6Xk4u9meNWLZQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61731},"main":"dist/index.js","_from":"file:songkeys-nestjs-redis-10.0.0.tgz","types":"dist/index.d.ts","engines":{"node":">=16.0.0"},"scripts":{"lint":"concurrently \"npm:lint:es\" \"npm:lint:tsc\"","test":"jest","build":"tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json","madge":"madge --image ./dependency-graph.svg dist/index.js","lint:es":"eslint \"{lib,test}/**/*.ts\"","lint:tsc":"tsc -p 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","make-badges":"istanbul-badges-readme --coverageDir=\"./coverage\" --readmeDir=\"./\" --style=\"flat-square\" --logo=\"jest\"","publish:next":"npm publish --tag next"},"_npmUser":{"name":"songkeys","email":"i@song.work"},"_resolved":"/tmp/c0a12ad13fe9672c69018348888c4585/songkeys-nestjs-redis-10.0.0.tgz","_integrity":"sha512-s56+NECuJXzcaPLYzpvA2xjL0e/1Zy55UE0q6b1UqpbQSKI06TFPFCWCMUadJigiuB26O1hxi+lmDbzahKvcLg==","repository":{"url":"git+https://github.com/songkeys/nestjs-redis.git","type":"git"},"_npmVersion":"8.19.4","description":"Redis(ioredis) module for Nest framework (node.js).","directories":{},"_nodeVersion":"16.20.1","dependencies":{"tslib":"2.6.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"peerDependencies":{"ioredis":"^5.0.0","@nestjs/core":"^10.0.0","@nestjs/common":"^10.0.0"},"_npmOperationalInternal":{"tmp":"tmp/nestjs-redis_10.0.0_1688628802009_0.048973122901276644","host":"s3://npm-registry-packages"}},"11.0.0":{"name":"@songkeys/nestjs-redis","version":"11.0.0","keywords":["redis","ioredis","sentinel","cluster","nestjs","nest","nodejs","node","typescript","javascript"],"author":{"name":"Songkeys","email":"songv587@gmail.com"},"license":"MIT","_id":"@songkeys/nestjs-redis@11.0.0","maintainers":[{"name":"songkeys","email":"i@song.work"}],"homepage":"https://github.com/songkeys/nestjs-redis#readme","bugs":{"url":"https://github.com/songkeys/nestjs-redis/issues"},"dist":{"shasum":"f3885f2c032fdebc0fbcb5d92bb9c65efb912de0","tarball":"https://registry.npmjs.org/@songkeys/nestjs-redis/-/nestjs-redis-11.0.0.tgz","fileCount":67,"integrity":"sha512-ck+8iPwp50iRxSsNCE+CtEGNzBFN+dnUIpdy4YllAB2pw/yZ4DDzJsBRqb/JGcebCdGWtlvHMMHcVnihKTOeOw==","signatures":[{"sig":"MEUCIQCKdBwFNnDZOjYzOj9GVPFsxA6Ks+wHTPsIVP865tFdHQIgfnMqI4DExe5P5BGeO6wYV2LJ27ZPimrttNwJNVw3eZU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":61754},"main":"dist/index.js","types":"dist/index.d.ts","engines":{"node":">=16.0.0"},"gitHead":"04ff648f1b5770f3e38a38c1c158c9f258d189ce","scripts":{"lint":"concurrently \"npm:lint:es\" \"npm:lint:tsc\"","test":"jest","build":"tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json","madge":"madge --image ./dependency-graph.svg dist/index.js","lint:es":"eslint \"{lib,test}/**/*.ts\"","lint:tsc":"tsc -p 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","make-badges":"istanbul-badges-readme --coverageDir=\"./coverage\" --readmeDir=\"./\" --style=\"flat-square\" --logo=\"jest\"","publish:next":"npm publish --tag next"},"_npmUser":{"name":"songkeys","email":"i@song.work"},"repository":{"url":"git+https://github.com/songkeys/nestjs-redis.git","type":"git"},"_npmVersion":"10.9.2","description":"Redis(ioredis) module for Nest framework (node.js).","directories":{},"_nodeVersion":"22.14.0","dependencies":{"tslib":"2.6.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"peerDependencies":{"ioredis":"^5.0.0","@nestjs/core":"^10.0.0 || ^11.0.0","@nestjs/common":"^10.0.0 || ^11.0.0"},"_npmOperationalInternal":{"tmp":"tmp/nestjs-redis_11.0.0_1754931408506_0.32086204361064374","host":"s3://npm-registry-packages-npm-production"}},"12.0.0":{"_id":"@songkeys/nestjs-redis@12.0.0","bugs":{"url":"https://github.com/songkeys/nestjs-redis/issues"},"dist":{"shasum":"007dcbc7b6701d5b509bbb44c9bbfdc38cacf1dd","tarball":"https://registry.npmjs.org/@songkeys/nestjs-redis/-/nestjs-redis-12.0.0.tgz","fileCount":67,"integrity":"sha512-qi3sMP5WHa5NHMM+LN83ePgDjAYEOkhe7GYvUwukpZds0msd9AhzokqYpc3V4BkR/elMhovEeRz6MgR7YtpYaw==","signatures":[{"sig":"MEYCIQCbAwE9TwMafmQioy8XHdqYrpqTfsvYE7Ocgt7qy94MVgIhAIy3ggGfPvlGBDynkPEiv+HCsFupfBTjwyd5GxrxXjZi","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIAUt70RnVqQrk/W85z3ANhLB/0jY3IsB1bNXUQdl/NCEAiEA2Cx2bzhCneUtGdq9Jk9UNTi5DO6A+KsoxZ9I+lzexFU="}],"unpackedSize":54157},"main":"./dist/index.js","name":"@songkeys/nestjs-redis","type":"commonjs","_from":"file:../release-packages/songkeys-nestjs-redis-12.0.0.tgz","types":"./dist/index.d.ts","author":{"name":"Songkeys","email":"songv587@gmail.com"},"engines":{"node":">=24.11.0"},"exports":"./dist/index.js","license":"MIT","scripts":{"lint":"concurrently \"npm:lint:es\" \"npm:lint:tsc\"","test":"node --experimental-vm-modules ../../node_modules/jest/bin/jest.js","build":"tsc --project tsconfig.build.json && tsc-alias -p tsconfig.build.json","lint:es":"eslint \"{lib,test}/**/*.ts\"","lint:tsc":"tsc --project tsconfig.json --noEmit","prebuild":"rimraf dist","test:cov":"node --experimental-vm-modules ../../node_modules/jest/bin/jest.js --coverage","test:e2e":"node --experimental-vm-modules ../../node_modules/jest/bin/jest.js --config ./test/jest-e2e.json","test:clear":"node --experimental-vm-modules ../../node_modules/jest/bin/jest.js --clearCache","test:watch":"node --experimental-vm-modules ../../node_modules/jest/bin/jest.js --watch"},"version":"12.0.0","_npmUser":{"name":"songkeys","email":"i@song.work"},"homepage":"https://github.com/songkeys/nestjs-redis#readme","keywords":["redis","ioredis","sentinel","cluster","nestjs","nest","nodejs","node","typescript","javascript"],"_resolved":"/Users/songkeys/Documents/Codex/2026-09-22/https-github-com-songkeys-nestjs-redis/work/release-packages/songkeys-nestjs-redis-12.0.0.tgz","_integrity":"sha512-qi3sMP5WHa5NHMM+LN83ePgDjAYEOkhe7GYvUwukpZds0msd9AhzokqYpc3V4BkR/elMhovEeRz6MgR7YtpYaw==","repository":{"url":"git+https://github.com/songkeys/nestjs-redis.git","type":"git","directory":"packages/redis"},"_npmVersion":"11.19.1","description":"Redis(ioredis) module for Nest framework (node.js).","directories":{},"maintainers":[{"name":"songkeys","email":"i@song.work"}],"_nodeVersion":"26.8.2","dependencies":{"tslib":"2.8.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"peerDependencies":{"ioredis":"^6.0.0","@nestjs/core":"^12.0.0","@nestjs/common":"^12.0.0"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/nestjs-redis_12.0.0_1790057829648_0.9748214543986795"}}},"time":{"created":"2023-07-06T07:33:21.941Z","modified":"2026-09-22T06:17:09.872Z","10.0.0":"2023-07-06T07:33:22.327Z","11.0.0":"2025-08-11T16:56:48.720Z","12.0.0":"2026-09-22T06:17:09.740Z"},"bugs":{"url":"https://github.com/songkeys/nestjs-redis/issues"},"author":{"name":"Songkeys","email":"songv587@gmail.com"},"license":"MIT","homepage":"https://github.com/songkeys/nestjs-redis#readme","keywords":["redis","ioredis","sentinel","cluster","nestjs","nest","nodejs","node","typescript","javascript"],"repository":{"url":"git+https://github.com/songkeys/nestjs-redis.git","type":"git","directory":"packages/redis"},"description":"Redis(ioredis) module for Nest framework (node.js).","maintainers":[{"name":"songkeys","email":"i@song.work"}],"readme":"![NPM Version](https://img.shields.io/npm/v/%40songkeys%2Fnestjs-redis?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(ioredis) module for Nest framework (node.js).\n
\n Explore the docs »\n
\n
\n View Examples\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\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- **Tested**: Unit tests and Redis/Cluster integration tests on Node.js 24 and 26.\n- **Services**: Retrieves **redis & cluster** connection via `RedisService`, `ClusterService`.\n\n## Migration\n\nThis branch adopts the upstream Service API and removes the old injection decorators.\nSee the [migration guide](/docs/upstream-migration.md) before upgrading.\n\n## Getting Started\n\n### Prerequisites\n\nThis lib requires **Node.js >=24.11.0**, **NestJS 12**, and **ioredis 6**.\n\nSee the [v12 migration guide](https://github.com/songkeys/nestjs-redis/blob/main/docs/upstream-migration.md) for the breaking API changes.\n\n### Installation\n\n```sh\n# with npm\nnpm install @songkeys/nestjs-redis ioredis\n# with yarn\nyarn add @songkeys/nestjs-redis ioredis\n# with pnpm\npnpm add @songkeys/nestjs-redis ioredis\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 - [Auto-reconnect](https://luin.github.io/ioredis/interfaces/CommonRedisOptions.html#retryStrategy)\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 - [Auto-reconnect](https://luin.github.io/ioredis/interfaces/ClusterOptions.html#clusterRetryStrategy)\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- [Full-Featured Redis Client - ioredis](https://github.com/luin/ioredis)\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/@songkeys/nestjs-redis?style=for-the-badge\n[downloads-url]: https://www.npmjs.com/package/@songkeys/nestjs-redis\n[stars-shield]: https://img.shields.io/github/stars/songkeys/nestjs-redis?style=for-the-badge\n[stars-url]: https://github.com/songkeys/nestjs-redis/stargazers\n[issues-shield]: https://img.shields.io/github/issues/songkeys/nestjs-redis?style=for-the-badge\n[issues-url]: https://github.com/songkeys/nestjs-redis/issues\n[license-shield]: https://img.shields.io/npm/l/@songkeys/nestjs-redis?style=for-the-badge\n[license-url]: https://github.com/songkeys/nestjs-redis/blob/main/LICENSE\n","readmeFilename":"README.md"}