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

[SDK-3967, SDK-3968] Remove false class exports in type declarations #1524

Merged
merged 2 commits into from
Jan 16, 2024
Merged

[SDK-3967, SDK-3968] Remove false class exports in type declarations #1524

merged 2 commits into from
Jan 16, 2024

Commits on Jan 15, 2024

  1. Remove false class exports in type declarations 

    The type declarations claim that the SDK exports all manner of classes
that it does not in fact export, such as Auth, Presence, PushAdmin,
AbstractRest, AbstractRealtime etc. Trying to import these classes will
result in a runtime (or bundler) error.

So, we convert them all to interfaces. (I can’t see an obvious downside
of doing this; let me know if there is.)

I’ve also addressed the ClientOptions docstring’s links to the Abstract*
constructors by rewording their text, since these links are now
completely broken (they were previously linking to a useless entry for a
nonexistent constructor).

Resolves #1519, resolves #1520.
    @lawrence-forooghian
    lawrence-forooghian committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    ff7cb41 View commit details
    Browse the repository at this point in the history

  2. Rename Abstract* classes to *Client 

    I _think_ that this reads better, now that as of ff7cb41 they’re no
longer classes.
    @lawrence-forooghian
    lawrence-forooghian committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    44eae5d View commit details
    Browse the repository at this point in the history