chat: update docs for async room get #2299
Merged
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
GregHolmes
requested changes
Nov 8, 2024
content/chat/rooms/index.textile
Outdated
| @@ -104,6 +106,8 @@ Releasing a room may be optional for many applications. If you have multiple tra | |||
| blang[javascript]. | |||
| Once "@rooms.release()@":https://sdk.ably.com/builds/ably/ably-chat-js/main/typedoc/interfaces/chat_js.Rooms.html#release has been called, the room will be unusable and a new instance will need to be created using "@rooms.get()@":#create if you want to reuse it. | |||
|
|
|||
| Note that calling @rooms.release()@ will cause any unresolved calls to @rooms.get()@ reject. | |||
There was a problem hiding this comment.
This doesn't quite read right at the end. Do you mean to @rooms.get()@ be rejected.?
There was a problem hiding this comment.
Yeah so any outstanding promises from rooms.get at the time of call will be rejected, will update
AndyTWF
force-pushed
the
chat-async-room-get
branch
from
6c9cc4a to
44be8f9
Compare
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 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 (
|
GregHolmes
approved these changes
Nov 8, 2024
splindsay-92
approved these changes
Nov 13, 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.
Description
Updates the chat docs to reflect the changes to async
rooms.get()CHA-670
Review
/chat/rooms