feat: Put custom event definitions in class #7640
Draft
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
joeyparrish
reviewed
Dec 2, 2024
lib/event/error_event.js
Outdated
| * specific error that occurred. In an uncompiled build, you can also use the | ||
| * <code>message</code> and <code>stack</code> properties to debug. | ||
| * @extends {shaka.util.FakeEvent} | ||
| * @exportDoc |
There was a problem hiding this comment.
Not sure, but should this be @export so it can be called by apps?
There was a problem hiding this comment.
If I change to @export the documentation is not generated correctly.... I don't know why...
lib/player.js
Outdated
| @@ -35,6 +35,7 @@ goog.require('shaka.media.StreamingEngine'); | |||
| goog.require('shaka.media.TimeRangesUtils'); | |||
| goog.require('shaka.net.NetworkingEngine'); | |||
| goog.require('shaka.net.NetworkingUtils'); | |||
| goog.require('shaka.Player.ErrorEvent'); | |||
There was a problem hiding this comment.
I think the errors are caused by ordering and namespaces here. goog.require here will assign the ErrorEvent class to shaka.Player.ErrorEvent. Later in this file, we assign shaka.Player = class ..., overwriting what was assigned to ErrorEvent by replacing the whole shaka.Player namespace.
So we might need to do something like this:
- Rename shaka.Player.ErrorEvent to shaka.errors.ErrorEvent, giving errors their own namespace
For backward compatibility, assign shaka.Player.ErrorEvent = shaka.errors.ErrorEvent after the definition of shaka.Player- Actually, no need for backward compatibility. That class never existed at runtime, and was also never in our externs. It only ever existed as a doc, so it's fine to rename it AFAICT. But the new name should be exported so it's in the generated externs/defs, where other projects can refer to it as a strong type.
There was a problem hiding this comment.
Done, but I used shaka.events.ErrorEvent instead
avelad
added
type: enhancement
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.
Close #1564