![\"AcmeKit\"](\"https://user-images.githubusercontent.com/7554214/153162406-bf8fd16f-aa98-4604-b87b-e13ab4baf604.png\")
\n \n\n \n \n \n
\nAn open source composable commerce engine built for developers.\n
\n\n\n## Overview\n\nRedis Event Bus module for AcmeKit. When installed, the events system of AcmeKit 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 @acmekit/event-bus-redis\n```\n\nAdd the module to your `acmekit-config.js`:\n\n```js\nmodule.exports = {\n // ...\n modules: [\n {\n resolve: \"@acmekit/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/acmekit/acmekit/blob/0c1d1d590463fa30b083c4312293348bdf6596be/packages/event-bus-redis/src/services/event-bus-redis.ts#L52) and [loader](https://github.com/acmekit/acmekit/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"}![\"AcmeKit](\"https://img.shields.io/badge/license-MIT-blue.svg\"){kind=icon}
\n ![\"Current](\"https://circleci.com/gh/acmekit/acmekit.svg?style=shield\")
\n ![\"PRs](\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat\"){kind=icon}
\n ![\"Product](\"https://img.shields.io/badge/Product%20Hunt-%231%20Product%20of%20the%20Day-%23DA552E\"){kind=icon}
![\"Discord](\"https://img.shields.io/badge/chat-on%20discord-7289DA.svg\"){kind=icon}
\n ![\"Follow](\"https://img.shields.io/twitter/follow/acmekit.svg?label=Follow%20@acmekit\")
\n