Skip to content

Commit b5df62f

Browse files
authored
docs(web-api): note the chat stream buffer size default (#2418)
1 parent be50825 commit b5df62f

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

packages/web-api/src/WebClient.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -515,6 +515,8 @@ export class WebClient extends Methods {
515515
*
516516
* @description The "chatStream" method starts a new chat stream in a conversation that can be appended to. After appending an entire message, the stream can be stopped with concluding arguments such as "blocks" for gathering feedback.
517517
*
518+
* The "markdown_text" content is appended to a buffer before being sent to the recipient, with a default buffer size of "256" characters. Setting the "buffer_size" value to a smaller number sends more frequent updates for the same amount of characters, but might reach rate limits more often.
519+
*
518520
* @example
519521
* const streamer = client.chatStream({
520522
* channel: "C0123456789",

0 commit comments

Comments
 (0)