Fix typings for RealtimeChannel.modes
#1955
Open
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
WalkthroughThe changes modify the TypeScript type definitions for channel modes in the Changes
Assessment against linked issues
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (6)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
github-actions
bot
temporarily deployed
to
staging/pull/1955/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1955/features
github-actions
bot
temporarily deployed
to
staging/pull/1955/typedoc
SimonWoolf
approved these changes
Jan 21, 2025
| @@ -853,19 +853,19 @@ declare namespace ChannelModes { | |||
| /** | |||
There was a problem hiding this comment.
Maybe worth leave a link to this pr or #1954 in the docstring comment for ChannelModes to explain the redundant values
There was a problem hiding this comment.
Done 👍
For some reason, this property returns lowercased values. So, reflect this in the typings. This is the only non-breaking change we can make, since: - if we change the return value of RealtimeChannel.modes to be uppercase, that will break things for users who are checking this return value against a list of lowercase values (having previously observed that this property returns lowercase values even though it contradicts the typings) - if we change the ChannelModes type to be lowercase, then we break things for TypeScript users who are setting `modes` in their channel options I have also changed the ChannelModes type to indicate that it accepts lowercased values; this allows a user to pass a ResolvedChannelModes when setting `modes` in their channel options. In our next major release, we should remove this duplicate type and only allow a single case (probably lowercase, since that's what we use for all of the other enum values in this SDK). Have created #1954 for this. Resolves #1952.
lawrence-forooghian
force-pushed
the
1952-ChannelModes-case
branch
from
778bfe5 to
bf3c202
Compare
VeskeR
approved these changes
Jan 23, 2025
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.
For some reason, this property returns lowercased values. So, reflect this in the typings. This is the only non-breaking change we can make, since:
if we change the return value of
RealtimeChannel.modesto be uppercase, that will break things for users who are checking this return value against a list of lowercase values (having previously observed that this property returns lowercase values even though it contradicts the typings)if we change the
ChannelModestype to be lowercase, then we break things for TypeScript users who are settingmodesin their channel optionsI have also changed the
ChannelModestype to indicate that it accepts lowercased values; this allows a user to pass aResolvedChannelModeswhen settingmodesin their channel options.In our next major release, we should remove this duplicate type and only allow a single case (probably lowercase, since that's what we use for all of the other enum values in this SDK). Have created #1954 for this.
Resolves #1952.
Summary by CodeRabbit
New Features
ResolvedChannelModetype for more flexible channel mode handling.Improvements