Documents WorkerEvents #446
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ThHareau
changed the title
EventEmitter should be used, it might be useful to other to add these examples to the documentation. Tell me what you think of this PR 🙂 fix #385: Documents WorkerEvents
benjie
requested changes
Mar 11, 2024
ThHareau
commented
Mar 11, 2024
website/docs/worker-events.md
Outdated
Comment on lines
124
to
127
| /** | ||
| * When a worker is created | ||
| */ | ||
| "worker:fatalError": { worker: Worker; error: any; jobError: any | null }; |
There was a problem hiding this comment.
Also I've noticed that this comment is probably wrong. Do you have a suggestion for a better documentation?
I had a look at the code, is it when the worker cannot be created? In that case, what would you think of this proposition?
Suggested change
| /** | |
| * When a worker is created | |
| */ | |
| "worker:fatalError": { worker: Worker; error: any; jobError: any | null }; | |
| /** | |
| * When a worker cannot be created because of an unhandled error | |
| */ | |
| "worker:fatalError": { worker: Worker; error: any; jobError: any | null }; |
|
@benjie did you had a chance to take a look? |
benjie
requested changes
Apr 2, 2024
|
Live here: https://worker.graphile.org/docs/worker-events 🙌 |
|
That's great! Thanks @benjie! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I was having trouble understanding how worker events could be used inside the configuration file. The example provided in #385 helped me.
I figured that since we were at least two not understanding how
EventEmittershould be used, it might be useful to other to add these examples to the documentation.Tell me what you think of this PR 🙂
Performance impact
None, documentation only
Security impact
None, documentation only
Checklist
yarn lint:fixpasses.yarn testpasses.RELEASE_NOTES.mdfile (if one exists).