[SDK-3967, SDK-3968] Remove false class exports in type declarations #1524
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
github-actions
bot
temporarily deployed
to
staging/pull/1524/features
github-actions
bot
temporarily deployed
to
staging/pull/1524/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1524/typedoc
lawrence-forooghian
force-pushed
the
1519-remove-false-class-exports
branch
from
4c36096 to
2d0aa6a
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1524/features
github-actions
bot
temporarily deployed
to
staging/pull/1524/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1524/typedoc
lawrence-forooghian
changed the title
lawrence-forooghian
force-pushed
the
909-remove-Types-namespace
branch
3 times, most recently
from
ac4f118 to
30f267d
Compare
lawrence-forooghian
force-pushed
the
1519-remove-false-class-exports
branch
from
2d0aa6a to
9af35c2
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1524/features
github-actions
bot
temporarily deployed
to
staging/pull/1524/bundle-report
owenpearson
requested changes
Jan 9, 2024
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.
I _think_ that this reads better, now that as of ff7cb41 they’re no longer classes.
lawrence-forooghian
force-pushed
the
1519-remove-false-class-exports
branch
from
9af35c2 to
44eae5d
Compare
owenpearson
approved these changes
Jan 15, 2024
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.
Note: This PR is based on top of #1518, please review that one first.
Resolves #1519, resolves #1520. See commit messages for more details.