feat: Allow to fully type events by extending the NextcloudEvents interface
#755
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
…nterface Signed-off-by: Ferdinand Thiessen <[email protected]>
susnux
force-pushed
the
feat/types-events
branch
from
d8d88fa to
81048d8
Compare
pulsejet
reviewed
Apr 21, 2024
There was a problem hiding this comment.
Didn't test but looks good! The only thing I'm confused about: would this work when multiple libraries / apps extend the interface? E.g. if @nextcloud/files provides some events then we want to be able to use them in the downstream app, along with events from the downstream app itself.
Comment on lines
+25
to
+27
| * import { emit } from '@nextcloud/event-bus' | ||
| * // Here the type of 'params' is infered automatically | ||
| * emit('my-event', (params) => { console.debug(params.foo, params.bar) }) |
Yes interfaces are only extended, not overwritten. Tested this with the files app locally (quickly added types for |
ShGKme
approved these changes
Apr 22, 2024
This was referenced May 6, 2024
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.
Sadly TypeScript currently does not support partially infered types, so we need to use a "global" interface like
NextcloudEventsfor this purpose.This now allows to extend that interface for automatically typed functions.
We could also e.g. include the
files:events in the@nextcloud/fileslibrary so they are automatically included when using both the event-bus and files library :)