Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@medusajs/event-bus-redis) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@medusajs/event-bus-redis

Documentation | Website

An open source composable commerce engine built for developers.

Overview

Redis 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.

Getting started

Install the module:

yarn add @medusajs/event-bus-redis

Add the module to your medusa-config.js:

module.exports = {
  // ...
  modules: [
    {
      resolve: "@medusajs/event-bus-redis",
      options: {
        redisUrl: "redis:..",
      },
    },
  ],
  // ...
}

Configuration

The module can be configured with the following options:

Option	Type	Description	Default
`redisUrl`	`string`	URL of the Redis instance to connect to.	`events-worker`
`queueName`	`string?`	Name of the BullMQ queue.	`events-queue`
`queueOptions`	`object?`	Options for the BullMQ queue. See BullMQ's documentation.	`{}`
`redisOptions`	`object?`	Options for the Redis instance. See `io-redis`'s documentation	`{}`

Info: See how the options are applied in the RedisEventBusService and loader.

If you do not provide a redisUrl in the module options, the server will fail to start.