Interface Mediator<Context, EventName>

Gets the current context in a readonly format.

Method

Example

// Get and log the current context.
const currentContext = myMediator.getContext()
console.log('Current context:', currentContext)
Copy

Removes an event listener from the Mediator.

Method

Example

// Use .off  to listen the event once
const myListener = (ctx: Readonly<MyContext>) => {
  console.log('my listener')
  myMediator.off('item:purchase', myListener)
}
myMediator.on('item:purchase', myListener)
Copy

Adds an event listener to the Mediator.

Method

Example

// to listen to a specific event
myMediator.on('item:add', (ctx: Readonly<MyContext>) =>
  console.log(`product added`)
)

// to listen to any event 
myMediator.on('*', (ctx: Readonly<MyContext>, event: MyEvent) =>
  console.log(`${event} modify context to`, ctx))
)
Copy

Sends an event through the Mediator, optionally modifying the context.

Method

Example

// Send a specific event with context modification.
myMediator.send('item:add', (ctx: Readonly<MyContext>) => ({
  ...ctx,
   items: [...ctx.items, 123]
}))

// Send a specific event without context modification.
myMediator.send('item:purchase')
Copy