@tlukastee/event-bus-redis
TypeScript icon, indicating that this package has built-in type declarations

1.8.13 • Public • Published

Medusa

@tlukastee/event-bus-redis

An open source composable commerce engine built for developers.

Medusa is released under the MIT license. Current CircleCI build status. PRs welcome! Product Hunt Discord Chat Follow @tlukastee

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 @tlukastee/event-bus-redis

Add the module to your medusa-config.js:

module.exports = {
  // ...
  modules: [
    {
      resolve: "@tlukastee/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.

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
1.8.130latest

Version History

VersionDownloads (Last 7 Days)Published
1.8.130

Package Sidebar

Install

npm i @tlukastee/event-bus-redis

Weekly Downloads

0

Version

1.8.13

License

MIT

Unpacked Size

25.3 kB

Total Files

17

Last publish

Collaborators

  • tlukastee