From b8dc1f1d6f25687da56ceb92bd9adc6a77e27eb3 Mon Sep 17 00:00:00 2001 From: martincupela Date: Thu, 16 Nov 2023 14:06:29 +0100 Subject: [PATCH] docs: document signature change to doSendMessageRequest prop --- .../v11/doSendMessageRequest-signature.mdx | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docusaurus/docs/React/release-guides/v11/doSendMessageRequest-signature.mdx diff --git a/docusaurus/docs/React/release-guides/v11/doSendMessageRequest-signature.mdx b/docusaurus/docs/React/release-guides/v11/doSendMessageRequest-signature.mdx new file mode 100644 index 000000000..865bd9b64 --- /dev/null +++ b/docusaurus/docs/React/release-guides/v11/doSendMessageRequest-signature.mdx @@ -0,0 +1,20 @@ +--- +id: minor-breaking-changes-v11 +sidebar_position: 4 +title: Minor breaking changes 11.0.0 +keywords: [migration guide, upgrade, breaking changes, v11] +--- + +### Channel instance as a first argument to doSendMessageRequest + +The `doSendMessageRequest` will from now on be passed the `Channel` instance instead of its CID to avoid forcing the developers to recreate a reference to the `Channel` instance inside the `doSendMessageRequest` function. The developers should adjust their implementation of `doSendMessageRequest` to call directly `await channel.sendMessage(messageData, options)`: + +```ts +import { ChannelProps } from 'stream-chat-react'; + +const doSendMessageRequest: ChannelProps['doSendMessageRequest'] = async (channel, messageData, options) => { + // optional custom logic + await channel.sendMessage(messageData, options); + // optional custom logic +} +```