Fix types of sub-messages in class declaration #1952
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
Prior to this change the class' jsdoc comments would state the type of
the class properties that encode sub-messages as:
/**
* Sent editMessage.
* @member {proto.IEditMessage|null|undefined} editMessage
* @memberof proto.SyncMessage.Sent
* @instance
*/
After the change:
/**
* Sent editMessage.
* @member {proto.EditMessage|null|undefined} editMessage
* @memberof proto.SyncMessage.Sent
* @instance
*/
The difference is that the latter specifices the class type and not the
interface which better reflects the actual type returned by `.decode()`
method.
This is a breaking change because constructing the class would now
require providing the class instances and not interfaces
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.
Prior to this change the class' jsdoc comments would state the type of the class properties that encode sub-messages as:
After the change:
The difference is that the latter specifices the class type and not the interface which better reflects the actual type returned by
.decode()method.This is a breaking change because constructing the class would now require providing the class instances and not interfaces