github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-12-23 16:54:04 +00:00
Code Issues Projects Releases Packages Wiki Activity
hedgedoc/docs/content/dev/events.md
Philip Molares 5dffe35ea1 docs: add documentation about events 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2022-10-02 20:51:23 +02:00

712 B
Raw Blame History

In HedgeDoc 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 defintion a comment should tell you what exactly this value should be.