Skip to content

fix: type issues from platform docs check; add docs snippet test for the platform docs - #1914

Merged
szuperaz merged 2 commits into
masterfrom
platform-code-snippets
Oct 15, 2026
Merged

szuperaz merged 2 commits into
masterfrom
platform-code-snippets

Conversation

@szuperaz

@szuperaz szuperaz commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

https://linear.app/stream/issue/REACT-1071/update-client-side-docs-code-snippets-to-stream-chat-js-v10

Tests stream-chat-js docs snippets from Platform docs. Similar to my previous docs snippet PR, but that one tested Chat docs.

The PR title is fix because the tests found two type issues.

@szuperaz szuperaz changed the title fix: fix missing type definition; add docs snippet test for the platform docs fix: type issues from platform docs check; add docs snippet test for the platform docs Oct 14, 2026
@szuperaz
szuperaz merged commit c7706d2 into master Oct 15, 2026
7 of 8 checks passed
@szuperaz
szuperaz deleted the platform-code-snippets branch October 15, 2026 14:10
github-actions Bot pushed a commit that referenced this pull request Oct 16, 2026
## [10.0.0-rc.22](v10.0.0-rc.21...v10.0.0-rc.22) (2026-10-16)

### ⚠ BREAKING CHANGES

* `StreamChatOptions` and `client.options` are removed.
`new StreamChat(key, config)` and `StreamChat.getInstance(key, config)` take
the configuration tree (`DeepPartial<InstanceConfigTree>`) as their second
argument; the `config` wrapper is dropped.
Option moves:
- `allowServerSideConnect`, `axiosRequestConfig`, `baseURL`, `browser`,
  `persistUserOnConnectionFailure` -> `client.<same name>`
- `notifications` -> `client.notificationManager`
- top-level axios fields (`timeout`, `httpsAgent`, ...) ->
  `client.axiosRequestConfig.<key>`
Example: `new StreamChat(key, { client: { allowServerSideConnect: true } })`.
`client.persistUserOnConnectionFailure` is no longer a field (use
`client.config.setConfig('client', { persistUserOnConnectionFailure })`);
`client.browser` and `client.node` are read-only getters.
`baseURL`, `axiosRequestConfig` and `notificationManager` are read at
construction, and the tree copies `axiosRequestConfig` instead of keeping
your object. See v9-to-v10-migration-guide-client-construction.md.

### Bug Fixes

* don't override local message attachments in createLinkPreviewsCo… ([#1885](#1885)) ([2aa5144](2aa5144))
* ensure API errors parsing works even with multiple axios copies ([#1909](#1909)) ([e0cfba9](e0cfba9))
* stability and perf fixes ([#1910](#1910)) ([080af2c](080af2c))
* type fixes from docs check; add docs snippet runner ([#1902](#1902)) ([2095fc1](2095fc1))
* type issues from platform docs check; add docs snippet test for the platform docs ([#1914](#1914)) ([c7706d2](c7706d2))
* **types:** add before_message_send_hook_system_messages to app settings response ([#1887](#1887)) ([724b4f7](724b4f7))

### Features

* add poll translation i18n fields ([#1878](#1878)) ([9d396e5](9d396e5)), closes [GetStream/chat#17029](https://github.com/GetStream/chat/issues/17029)
* poll optimistic updates ([#1895](#1895)) ([e3dac59](e3dac59))
* replace StreamChatOptions with the configuration tree ([#1911](#1911)) ([f05b861](f05b861))
@stream-ci-bot

Copy link
Copy Markdown

🎉 This PR is included in version 10.0.0-rc.22 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants