{"_id":"@8medusa/event-bus-redis","name":"@8medusa/event-bus-redis","dist-tags":{"latest":"2.7.0"},"versions":{"2.7.0":{"name":"@8medusa/event-bus-redis","version":"2.7.0","description":"Redis Event Bus Module for Medusa","main":"dist/index.js","repository":{"type":"git","url":"git+https://github.com/medusajs/medusa.git","directory":"packages/modules/event-bus-redis"},"publishConfig":{"access":"public"},"engines":{"node":">=20"},"author":{"name":"Medusa"},"license":"MIT","devDependencies":{"@8medusa/framework":"2.7.0","@swc/core":"^1.7.28","@swc/jest":"^0.2.36","jest":"^29.7.0","rimraf":"^5.0.1","typescript":"^5.6.2"},"scripts":{"watch":"tsc --build --watch","build":"rimraf dist && tsc --build","test":"jest --silent --bail --maxWorkers=50% --forceExit"},"dependencies":{"bullmq":"5.13.0","ioredis":"^5.4.1"},"peerDependencies":{"@8medusa/framework":"2.7.0","awilix":"^8.0.1"},"_id":"@8medusa/event-bus-redis@2.7.0","gitHead":"8618e6ee3843069ea189ea64d5191d93db52dc9d","types":"./dist/index.d.ts","bugs":{"url":"https://github.com/medusajs/medusa/issues"},"homepage":"https://github.com/medusajs/medusa#readme","_nodeVersion":"22.14.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-RZFhV9Ei+tJqhoL6j9smGrGaxcjutjvo6/fdDEsdrLNzB9/JFRV2TV2CthgJGnxwdDK0g1alrXQUA6NZ4GeD6Q==","shasum":"2415d96e20753388873a135b3fb58b66e27fc44c","tarball":"https://registry.npmjs.org/@8medusa/event-bus-redis/-/event-bus-redis-2.7.0.tgz","fileCount":23,"unpackedSize":34349,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCICIhduQA+RAYQI778Hbq3Eaihwg3kxXnlIBpk2vGcQhwAiEA4SpSFM7r7pkAaN/PanRHxgkpYPfrTlYhVTX0bkalysc="}]},"_npmUser":{"name":"8seneca","email":"8seneca@gmail.com"},"directories":{},"maintainers":[{"name":"8seneca","email":"8seneca@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/event-bus-redis_2.7.0_1744943126474_0.04418624639457791"},"_hasShrinkwrap":false}},"time":{"created":"2025-04-18T02:25:26.406Z","2.7.0":"2025-04-18T02:25:26.637Z","modified":"2025-04-18T02:25:26.872Z"},"maintainers":[{"name":"8seneca","email":"8seneca@gmail.com"}],"description":"Redis Event Bus Module for Medusa","homepage":"https://github.com/medusajs/medusa#readme","repository":{"type":"git","url":"git+https://github.com/medusajs/medusa.git","directory":"packages/modules/event-bus-redis"},"author":{"name":"Medusa"},"bugs":{"url":"https://github.com/medusajs/medusa/issues"},"license":"MIT","readme":"<p align=\"center\">\n  <a href=\"https://www.medusajs.com\">\n    <img alt=\"Medusa\" src=\"https://user-images.githubusercontent.com/7554214/153162406-bf8fd16f-aa98-4604-b87b-e13ab4baf604.png\" width=\"100\" />\n  </a>\n</p>\n<h1 align=\"center\">\n  @8medusa/event-bus-redis\n</h1>\n\n<h4 align=\"center\">\n  <a href=\"https://docs.medusajs.com\">Documentation</a> |\n  <a href=\"https://www.medusajs.com\">Website</a>\n</h4>\n\n<p align=\"center\">\nAn open source composable commerce engine built for developers.\n</p>\n<p align=\"center\">\n  <a href=\"https://github.com/medusajs/medusa/blob/master/LICENSE\">\n    <img src=\"https://img.shields.io/badge/license-MIT-blue.svg\" alt=\"Medusa is released under the MIT license.\" />\n  </a>\n  <a href=\"https://circleci.com/gh/medusajs/medusa\">\n    <img src=\"https://circleci.com/gh/medusajs/medusa.svg?style=shield\" alt=\"Current CircleCI build status.\" />\n  </a>\n  <a href=\"https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md\">\n    <img src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat\" alt=\"PRs welcome!\" />\n  </a>\n    <a href=\"https://www.producthunt.com/posts/medusa\"><img src=\"https://img.shields.io/badge/Product%20Hunt-%231%20Product%20of%20the%20Day-%23DA552E\" alt=\"Product Hunt\"></a>\n  <a href=\"https://discord.gg/xpCwq3Kfn8\">\n    <img src=\"https://img.shields.io/badge/chat-on%20discord-7289DA.svg\" alt=\"Discord Chat\" />\n  </a>\n  <a href=\"https://twitter.com/intent/follow?screen_name=medusajs\">\n    <img src=\"https://img.shields.io/twitter/follow/medusajs.svg?label=Follow%20@8medusa\" alt=\"Follow @8medusa\" />\n  </a>\n</p>\n\n## Overview\n\nRedis Event Bus module for Medusa. When installed, the events system of Medusa is powered by BullMQ and `io-redis`. BullMQ is responsible for the message queue and worker. `io-redis` is the underlying Redis client, that BullMQ connects to for events storage.\n\n## Getting started\n\nInstall the module:\n\n```bash\nyarn add @8medusa/event-bus-redis\n```\n\nAdd the module to your `medusa-config.js`:\n\n```js\nmodule.exports = {\n  // ...\n  modules: [\n    {\n      resolve: \"@8medusa/event-bus-redis\",\n      options: {\n        redisUrl: \"redis:..\",\n      },\n    },\n  ],\n  // ...\n}\n```\n\n## Configuration\n\nThe module can be configured with the following options:\n\n| Option         | Type      | Description                                                                                                              | Default         |\n| -------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ | --------------- |\n| `redisUrl`     | `string`  | URL of the Redis instance to connect to.                                                                                 | `events-worker` |\n| `queueName`    | `string?` | Name of the BullMQ queue.                                                                                                | `events-queue`  |\n| `queueOptions` | `object?` | Options for the BullMQ queue. See BullMQ's [documentation](https://api.docs.bullmq.io/interfaces/QueueOptions.html).     | `{}`            |\n| `redisOptions` | `object?` | Options for the Redis instance. See `io-redis`'s [documentation](https://luin.github.io/ioredis/index.html#RedisOptions) | `{}`            |\n\n**Info**: See how the options are applied in the [RedisEventBusService](https://github.com/medusajs/medusa/blob/0c1d1d590463fa30b083c4312293348bdf6596be/packages/event-bus-redis/src/services/event-bus-redis.ts#L52) and [loader](https://github.com/medusajs/medusa/blob/0c1d1d590463fa30b083c4312293348bdf6596be/packages/event-bus-redis/src/loaders/index.ts).\n\nIf you do not provide a `redisUrl` in the module options, the server will fail to start.\n","readmeFilename":"README.md","_rev":"1-05aa69179ebf46c3e429eb56a993caf5"}