github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-12-22 16:41:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: Move 'Events' to design docs

Browse source 
Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren 2023-03-12 21:31:29 +01:00
parent 58f306a38c
commit 3c957e9b0e
2 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/content/dev/events.md → docs/content/dev/design_docs/events.md
View file

@ -1,8 +1,12 @@
In HedgeDoc 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.
# Events
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 defintion a comment should tell you what exactly this value should be.
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

1
docs/mkdocs.yml
View file

@ -23,6 +23,7 @@ nav:
- '2.0 Development': dev/2.0.md
- Design Documents:
- API Authentication: dev/design_docs/api_auth.md
- Events: dev/design_docs/events.md
- Notes: dev/design_docs/notes.md
- 'User Profiles & Authentication': dev/design_docs/user_profiles.md
- Configuration: dev/design_docs/config.md