feat(use-x-bus): unsubscribe from bus events when component is unmounted #1472
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
diegopf
reviewed
May 17, 2024
| const xAliasAPI = useAliasApi(); | ||
| const xBusAPI = useXBus(); | ||
| return Object.assign(xAliasAPI, xBusAPI); | ||
| } | ||
|
|
| subscription.unsubscribe(); | ||
| Object.entries(listeners as XEventListeners).forEach(([eventName, callback]) => { | ||
| xBus.on(eventName as XEvent, true).subscribe(({ eventPayload, metadata }) => { | ||
| callback(eventPayload as never, metadata); |
There was a problem hiding this comment.
I'm not sure if I understand this cast🤔
There was a problem hiding this comment.
It is because callback payload is inferred as never due to TS can't know listeners type in build time. It is generic for any event.
I'm sure we could improve the type inference, but further on.
diegopf
approved these changes
May 21, 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.
useXBus.onfunction registers the subscriptions itself to be able to unsubscribe once the component is unmounted.useXBus.emitnow returns the emission promise.Highlights:
KeepAlivein the_vue3package since components doesn't have active subscriptions once the component is unmounted.withMetadais required$x.on('ColumnsNumberProvided', false). It is because improve type safe when$x.onand conditional metadatauseXbushas improved the type infer. No more needed type assertions to retrieve payload with or withoutmetadata. Like: https://github.com/empathyco/x/compare/EMP-4083-usexbus-unmounted?expand=1#diff-1c8a891163d5ec75f3348e5d88e9c5a8560fc77b7d7b3ee9f682be58ae209d90R23 or https://github.com/empathyco/x/compare/EMP-4083-usexbus-unmounted?expand=1#diff-1b602dc109cfb36aa80b79eab7803c7ee38818376457049a42eca050108aa746R98rxjsin Vue components because nowobservableorsubscriptionare not returned in theuseXBuscomposable ✌🏾Type of change
What is the destination branch of this PR?
MainChecklist: