docs: update useChat reference to match actual behavior#7588
Merged
lgrammel merged 1 commit intovercel:mainfrom Jul 28, 2025
Merged
docs: update useChat reference to match actual behavior#7588lgrammel merged 1 commit intovercel:mainfrom
lgrammel merged 1 commit intovercel:mainfrom
Conversation
lgrammel
approved these changes
Jul 28, 2025
lgrammel
changed the title
Collaborator
|
any prs with docs fixes are much appreciated! |
Comment on lines
+114
to
+125
| } | ||
| { | ||
| name: 'body', | ||
| type: 'Record<string, any> | undefined', | ||
| description: 'The request body', | ||
| } | ||
| { | ||
| name: 'credentials', | ||
| type: 'RequestCredentials | undefined', | ||
| description: 'The request credentials', | ||
| } | ||
| { |
Collaborator
There was a problem hiding this comment.
@bytaesu for future reference, please remember to add , between properties here
Contributor
Author
There was a problem hiding this comment.
Got it! I ran Prettier but missed this. Would’ve been easier if I had access to the docs app😅
nicoalbanese
added a commit
that referenced
this pull request
Jul 28, 2025
submodule action broken, fixes #7588
Contributor
Author
Alright, I’ll fix anything I spot. |
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
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.
Background
Important reference for
useChatin v5 is missing.Without the
prepareReconnectToStreamRequestoption,resumeStream doesn't work when it doesn't match the default setups.
Summary
Fixed prepareSendMessagesRequest reference and added prepareReconnectToStreamRequest reference.
No changes other than documentation.
Tasks
pnpm changesetin the project root)pnpm prettier-fixin the project root)Future Work
I noticed that many parts of the actual behavior didn’t match the documentation.
Let me know specifically which parts need documentation updates, and I’ll be happy to help.
Feel free to leave a comment if needed.