Files
medusa-store/packages/modules/event-bus-local
Harminder Virk f579f0b3be feat: restructure events payload (#8143)
* refactor: restructure events payload

Breaking change: This PR changes the event payload accepted by the event
listeners

* refactor: fix failing tests and implement feedback

* add integration tests

* fix timeout

---------

Co-authored-by: Adrien de Peretti <adrien.deperetti@gmail.com>
2024-07-16 17:09:16 +01:00
..
2024-06-20 12:59:33 +02:00

Medusa

@medusajs/event-bus-local

Documentation | Website

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

Overview

Local Event Bus module for Medusa. When installed, the events system of Medusa is powered by the Node EventEmitter. This module installed by default in new (> v1.8.0) Medusa projects.

The Node EventEmitter is limited to a single process environment. We generally recommend using the @medusajs/event-bus-redis module in a production environment.

Getting started

Install the module:

yarn add @medusajs/event-bus-local

You don't need to add the module to your project configuration as it is the default one. Medusa will try to use it, if no other event buses are installed.

module.exports = {
  // ...
  modules: [ ... ],
  // ...
}

Configuration

The module comes with no configuration options.