mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-22 17:56:30 -05:00
e07cd62596
This rewrite follows the principles of https://diataxis.fr/ Co-authored-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
18 lines
909 B
Markdown
18 lines
909 B
Markdown
# Events
|
|
|
|
!!! info "Design Document"
|
|
This is a design document, explaining the design and vision for a HedgeDoc 2
|
|
feature. It is not a user guide and may or may not be fully implemented.
|
|
|
|
In HedgeDoc 2, we use an event system based on [EventEmitter2][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][nestjs/eventemitter].
|
|
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.
|
|
|
|
[eventemitter2]: https://github.com/EventEmitter2/EventEmitter2
|
|
[nestjs/eventemitter]: https://docs.nestjs.com/techniques/events
|