Add ChatClient.dispose() documentation #3177
Draft
Conversation
This file contains hidden or 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
Add new section documenting ChatClient.dispose() method for JavaScript, React, Swift, Kotlin, and Jetpack Compose based on: - ably/ably-chat-swift#477 - ably/ably-chat-kotlin#188
|
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
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
m-hulbert
approved these changes
Feb 6, 2026
Contributor
m-hulbert
left a comment
m-hulbert
left a comment
There was a problem hiding this comment.
Minor nitpick but LGTM otherwise.
Comment on lines
+360
to
+362
| - Release all rooms managed by the client | ||
| - Clean up connection listeners and timers | ||
| - Free internal resources |
Contributor
There was a problem hiding this comment.
Suggested change
| - Release all rooms managed by the client | |
| - Clean up connection listeners and timers | |
| - Free internal resources | |
| - Release all rooms managed by the client. | |
| - Clean up connection listeners and timers. | |
| - Free internal resources. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Add documentation for the new
ChatClient.dispose()method that releases all resources associated with the chat client.Related PRs
Changes
dispose()does and its idempotent behaviordispose()