medusajs

Repositories Projects Packages

65

@medusajs/event-bus-redis (0.0.3)

Published 2026-03-25 06:37:33 +00:00 by piyush

Installation

Setup this registry in your project .npmrc file:

@medusajs:registry=

To install the package using npm, run the following command:

npm install @medusajs/event-bus-redis@0.0.3

or add it to the package.json file:

"@medusajs/event-bus-redis": "0.0.3"

For more information on the npm registry, see the documentation.

About this package

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

Dependencies

Dependencies

ID	Version
bullmq	5.13.0
ioredis	^5.4.1

Development dependencies

ID	Version
@medusajs/framework	0.0.3
@swc/core	^1.7.28
@swc/jest	^0.2.36
awilix	^8.0.1
jest	^29.7.0
rimraf	^5.0.5
typescript	^5.6.2

Peer dependencies

ID	Version
@medusajs/framework	0.0.3
awilix	^8.0.1

Details

npm

2026-03-25 06:37:33 +00:00

0

Medusa

Project website

MIT

dev

10 KiB

Assets (1)

event-bus-redis-0.0.3.tgz 10 KiB

Versions (2) View all

0.0.3 2026-03-25

0.0.2 2026-02-09