feat(Class): add support for class @emits and @listens #524
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
BREAKING CHANGE: `@emits` syntax changed * old: `@emits <identifier> [description]` * new: `@emits <type> <name> [-] [description]` BREAKING CHANGE: `@listens` syntax changed * old: `@listens <identifier> [description]` * new: `@listens <type> <name> [-] [description]`
ajmeese7
approved these changes
Jul 7, 2022
There was a problem hiding this comment.
Looks great! I am merging this into my fork of esdoc2 in the near future, I will be sure to mention your name to give credit where credit is due. Thanks for this!
Sorry that these guys really fell off, I'm trying to get some life back into esdoc2 as well since that was also seemingly abandoned.
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.
Add support for class-level
@emitsand@listens.Breaking Changes
@emitssyntax changedIt's possible to emit two different events of the same class type but with different names. As such, the
@emitssyntax was changed to provide a<name>for an emitted event. The<name>param is required because Web APIs prevent creating events without names.@emits <identifier> [description]@emits <type> <name> [-] [description]@listenssyntax changedEvent listeners are defined by event name, not by event class. As such, the
@listenssyntax was changed to provide a<name>for a listened event.@listens <identifier> [description]@listens <type> <name> [-] [description]