ContextQMD
Back to Medusa

README

packages/modules/event-bus-local/README.md

2.13.52.3 KB
Original Source
<p align="center"> <a href="https://www.medusajs.com"> </a> </p> <h1 align="center"> @medusajs/event-bus-local </h1> <h4 align="center"> <a href="https://docs.medusajs.com">Documentation</a> | <a href="https://www.medusajs.com">Website</a> </h4> <p align="center"> An open source composable commerce engine built for developers. </p> <p align="center"> <a href="https://github.com/medusajs/medusa/blob/master/LICENSE"> </a> <a href="https://circleci.com/gh/medusajs/medusa"> </a> <a href="https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md"> </a> <a href="https://www.producthunt.com/posts/medusa"></a> <a href="https://discord.gg/xpCwq3Kfn8"> </a> <a href="https://twitter.com/intent/follow?screen_name=medusajs"> </a> </p>

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:

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

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

Configuration

The module comes with no configuration options.