Shahed Nasser
2e16949979
* docs: update imports and package names across docs + reference configs * generate files * fix import * change preview to rc
53 lines
1.1 KiB
Plaintext
53 lines
1.1 KiB
Plaintext
export const metadata = {
|
||
title: `Local Event Bus Module`,
|
||
}
|
||
|
||
# {metadata.title}
|
||
|
||
The Local Event Bus Module uses Node EventEmitter to implement Medusa's pub/sub events system. The Node EventEmitter is limited to a single process environment.
|
||
|
||
This module is useful for development and testing, but it’s not recommended to be used in production.
|
||
|
||
For production, it’s recommended to use modules like [Redis Event Bus Module](../redis/page.mdx).
|
||
|
||
---
|
||
|
||
## Register the Local Event Bus Module
|
||
|
||
<Note>
|
||
|
||
The Local Event Bus Module is registered by default in your application.
|
||
|
||
</Note>
|
||
|
||
Add the module into the `modules` property of the exported object in `medusa-config.js`:
|
||
|
||
```js title="medusa-config.js"
|
||
const { Modules } = require("@medusajs/framework/utils")
|
||
|
||
// ...
|
||
|
||
module.exports = defineConfig({
|
||
// ...
|
||
modules: {
|
||
[Modules.EVENT_BUS]: true,
|
||
},
|
||
})
|
||
```
|
||
|
||
---
|
||
|
||
## Test the Module
|
||
|
||
To test the module, start the Medusa application:
|
||
|
||
```bash npm2yarn
|
||
npm run dev
|
||
```
|
||
|
||
You'll see the following message in the terminal's logs:
|
||
|
||
```bash noCopy noReport
|
||
Local Event Bus installed. This is not recommended for production.
|
||
```
|