Include tiny-emitter in events API migration strategy #494
Conversation
This file contains hidden or 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
src/guide/migration/events-api.md
Outdated
| @@ -58,6 +58,6 @@ We removed `$on`, `$off` and `$once` methods from the instance completely. `$emi | |||
|
|
|||
| ## Migration Strategy | |||
|
|
|||
| Existing event hubs can be replaced by using an external library implementing the event emitter interface, for example [mitt](https://github.com/developit/mitt). | |||
| Existing event hubs can be replaced by using an external library implementing the event emitter interface, for example [tiny-emitter](https://github.com/scottcorgan/tiny-emitter). | |||
There was a problem hiding this comment.
suggestion: would you mind if we leave both of them here? So people could make the choice and docs won't feel like we're promoting a certain library (we definitely made this mistake with mitt)?
Suggested change
| Existing event hubs can be replaced by using an external library implementing the event emitter interface, for example [tiny-emitter](https://github.com/scottcorgan/tiny-emitter). | |
| Existing event hubs can be replaced by using an external library implementing the event emitter interface, for example [mitt](https://github.com/developit/mitt) or [tiny-emitter](https://github.com/scottcorgan/tiny-emitter). |
There was a problem hiding this comment.
@NataliaTepluhina make sense and updated the PR.
There was a problem hiding this comment.
@yuripave thank you for bringing this! I've left a small suggestion for your consideration
yuripave
force-pushed
the
yuripave-patch-1
branch
from
fcad6b1 to
8441e13
Compare
yuripave
changed the title
NataliaTepluhina
approved these changes
Sep 18, 2020
There was a problem hiding this comment.
@yuripave thank you for the super fast fix! Happy to merge 🎉
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 of Problem
In the migration guide, it suggest using mitt to migrate existing event hubs, but its interface is incompatible with Vue 2 where:
$onceProposed Solution
I suggest to include tiny-emitter which its interface is fully compatible with Vue 2
$on,$offand$once, and its emit method do support variadic arguments.Additional Information
Closes #493