Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix types of sub-messages in class declaration #1952

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix types of sub-messages in class declaration #1952

wants to merge 1 commit into from

Commits on Nov 29, 2023

  1. Fix types of sub-messages in class declaration 

    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
    @indutny-signal
    indutny-signal committed Nov 29, 2023
    Configuration menu
    Copy the full SHA
    678f463 View commit details
    Browse the repository at this point in the history