Skip to content

Conversation

@zimeg
Copy link
Member

@zimeg zimeg commented Jan 28, 2026

Summary

This PR exports the ChatStreamer and ChatStreamerOptions from @slack/web-api for importing elsewhere with type safety 🎁

Preview

 /**
 * @param {import("@slack/web-api").ChatStreamer} streamer - Slack chat stream
 */

Fixes issues with jsdoc noted in sample app changes: https://github.com/slack-samples/bolt-js-assistant-template/pull/98/files#diff-a45b5e2e63df5007d9680c1776b0381dc48bcad3fbd9d443ac19e6dd077c386aR12 🤖

Notes

I considered adding the "chat-stream" file to known exports for the following result too, but don't feel so confident in this approach:

 /**
 * @param {import("@slack/web-api/chat-stream").ChatStreamer} streamer - Slack chat stream
 */

Requirements

@zimeg zimeg requested review from mwbrooks and srtaalej January 28, 2026 23:51
@zimeg zimeg self-assigned this Jan 28, 2026
@zimeg zimeg requested a review from a team as a code owner January 28, 2026 23:51
@zimeg zimeg added semver:patch enhancement M-T: A feature request for new functionality area:typescript issues that specifically impact using the package from typescript projects pkg:web-api applies to `@slack/web-api` labels Jan 28, 2026
@codecov
Copy link

codecov bot commented Jan 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.07%. Comparing base (f2ac218) to head (ca27644).
⚠️ Report is 1 commits behind head on feat-ai-apps-thinking-steps.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@                     Coverage Diff                      @@
##           feat-ai-apps-thinking-steps    #2481   +/-   ##
============================================================
  Coverage                        93.07%   93.07%           
============================================================
  Files                               40       40           
  Lines                            11213    11213           
  Branches                           708      708           
============================================================
  Hits                             10437    10437           
  Misses                             764      764           
  Partials                            12       12           
Flag Coverage Δ
cli-hooks 95.23% <ø> (ø)
cli-test 94.79% <ø> (ø)
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.

✅ Great find @zimeg! I'm glad our sample app development is exposing these improvements.

💭 I agree with you, this syntax feel more intuitive to me. 🚢

Copy link
Contributor

@srtaalej srtaalej left a comment

Choose a reason for hiding this comment

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

AH good catch! Thank you so much!

@mwbrooks mwbrooks merged commit 5ea954a into feat-ai-apps-thinking-steps Jan 29, 2026
39 of 57 checks passed
@mwbrooks mwbrooks deleted the zimeg-feat-web-api-export-chat-streamer branch January 29, 2026 18:08
@zimeg
Copy link
Member Author

zimeg commented Jan 29, 2026

@mwbrooks @srtaalej Likewise thanks both quite a lot for being so encouraging to iterations 👾 ✨

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

Labels

area:typescript issues that specifically impact using the package from typescript projects enhancement M-T: A feature request for new functionality pkg:web-api applies to `@slack/web-api` semver:patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants