github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-01-23 03:33:08 +00:00
Code Issues Projects Releases Packages Wiki Activity
hedgedoc/docs/content/dev/design_docs/events.md
David Mehren 3c957e9b0e docs: Move 'Events' to design docs 
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00

726 B
Raw Blame History

Events

In HedgeDoc 2, we use an event system based on EventEmitter2. It's used to reduce circular dependencies between different services and inform these services about changes.

HedgeDoc's system is basically the system NestJS offers.
The config for the EventEmitterModule is stored in events.ts and exported as eventModuleConfig.
In the same file enums for the event keys are defined. Each of these events is expected to be sent with an additional value. In the enum definition a comment should tell you what exactly this value should be.