Skip to content

Conversation

@zimeg
Copy link
Member

@zimeg zimeg commented Oct 24, 2025

Summary

This PR follows slackapi/bolt-js#2696 to note the WebClient#chatStream default buffer size.

Note

  • Planning to mirror this change to the Python SDK if the wording is alright! 🐍
  • Was unsure if this should be included in a different example? I left this unchanged for now 📚

Requirements

@zimeg zimeg added this to the [email protected] milestone Oct 24, 2025
@zimeg zimeg self-assigned this Oct 24, 2025
@zimeg zimeg added docs M-T: Documentation work only semver:patch pkg:web-api applies to `@slack/web-api` labels Oct 24, 2025
@codecov
Copy link

codecov bot commented Oct 24, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.01%. Comparing base (16bd88e) to head (6e96b17).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2418   +/-   ##
=======================================
  Coverage   93.01%   93.01%           
=======================================
  Files          40       40           
  Lines       11111    11113    +2     
  Branches      713      713           
=======================================
+ Hits        10335    10337    +2     
  Misses        764      764           
  Partials       12       12           
Flag Coverage Δ
cli-hooks 95.23% <ø> (ø)
cli-test 94.79% <ø> (ø)
oauth 77.39% <ø> (ø)
socket-mode 61.87% <ø> (ø)
web-api 98.07% <100.00%> (+<0.01%) ⬆️
webhook 96.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

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

✅ Thanks for keeping the docs helpful and accurate! 📚

Comment on lines +518 to +519
* 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.
*
Copy link
Member

Choose a reason for hiding this comment

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

note: Just thinking aloud - perhaps we should have a timer to flush the buffer in case 256 character isn't sent within a certain time limit 🤔 Adds complexity and bug-risk, but could be a good feature for people who are struggling with the buffer size.

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

Labels

docs M-T: Documentation work only pkg:web-api applies to `@slack/web-api` semver:patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants