Class WebEventService

Service to allow components to communicate with eachother through events

Index

Constructors

Methods

addEventListener dispatchEvent

Constructors

constructor

new WebEventService(): WebEventService
Returns WebEventService

Methods

addEventListener

addEventListener<T>(webEvent: Welcome, callback: (data: T) => void): void
Listen for a web event and execute a function when it occurs
Type Parameters
- T
  Type used for the event data
Parameters
- webEvent: Welcome
  Kind of web event to listen for
- callback: (data: T) => void
  Function to call when the web event occurs. Will get the event data as an argument.
Returns void
- Defined in apps/web/src/services/WebEventService.ts:15

dispatchEvent

dispatchEvent<T>(webEvent: Welcome, data?: T): void
Dispatch a web event
Type Parameters
- T
  Type used for the event data
Parameters
- webEvent: Welcome
  Kind of web event to dispatch
- Optionaldata: T
  Event data to send along with the dispatch
Returns void
- Defined in apps/web/src/services/WebEventService.ts:32