Skip to content

[DX-627] Adds an API reference for Chat in JavaScript#3212

Open
m-hulbert wants to merge 22 commits intomainfrom
dx-627-chat-js-api
Open

[DX-627] Adds an API reference for Chat in JavaScript#3212
m-hulbert wants to merge 22 commits intomainfrom
dx-627-chat-js-api

Conversation

@m-hulbert
Copy link
Contributor

Description

This PR adds an API reference for Chat in JavaScript/TypeScript using the new NestedTable and MethodSignature components. It should have parity with the TypeDoc references.

There is 1 commit per file, however I haven't yet updated the references in the conceptual content to point to these references yet to keep this PR smaller for review feedback. I will add that as a separate PR or final commit once we are happy with this content.

Checklist

@m-hulbert m-hulbert self-assigned this Feb 17, 2026
@m-hulbert m-hulbert added the review-app Create a Heroku review app label Feb 17, 2026
@coderabbitai
Copy link

coderabbitai bot commented Feb 17, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dx-627-chat-js-api

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ably-ci ably-ci temporarily deployed to ably-docs-dx-627-chat-j-1akazo February 17, 2026 17:44 Inactive
Copy link
Contributor

@splindsay-92 splindsay-92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly small issues, but there are a couple of API inconsistencies that need to be addressed :)

m-hulbert and others added 7 commits February 19, 2026 19:11
fixup! Adds a Chat JavaScript API reference page for ChatClient

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
fixup! Adds a Chat JavaScript API reference page for Connection

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
fixup! Adds a Chat JavaScript API reference page for MessageReactions

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
fixup! Adds a Chat JavaScript API reference page for Message

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
fixup! Adds a Chat JavaScript API reference page for Messages

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
fixup! Adds a Chat JavaScript API reference page for Presence

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
fixup! Adds a Chat JavaScript API reference page for Rooms

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@m-hulbert m-hulbert temporarily deployed to ably-docs-dx-627-chat-j-1akazo February 20, 2026 09:33 Inactive
@m-hulbert m-hulbert temporarily deployed to ably-docs-dx-627-chat-j-1akazo February 20, 2026 10:15 Inactive
@m-hulbert m-hulbert temporarily deployed to ably-docs-dx-627-chat-j-1akazo February 20, 2026 12:20 Inactive
Copy link
Contributor

@splindsay-92 splindsay-92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review-app Create a Heroku review app

Development

Successfully merging this pull request may close these issues.

3 participants