Skip to content

fix: add optional raw queryChannels api response #1530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 12, 2025

Conversation

isekovanic
Copy link
Contributor

@isekovanic isekovanic commented May 9, 2025

CLA

  • I have signed the Stream CLA (required).
  • Code changes are tested

Description of the changes, What, Why and How?

This PR allows client.queryChannels to optionally return the raw response and not run hydration at all (and subsequently not provide an array of Channel instances).

It is meant to be used generally server-side so that integrators can have access to other fields not available in a Channel instance. It should resolve this Zendesk ticket.

We can probably keep it the same api if we use discriminated unions, but I feel like it'd complicate things further for no good reason. Keeping the apis separate made sense to me.

Changelog

Copy link
Contributor

github-actions bot commented May 9, 2025

Size Change: +248 B (+0.07%)

Total Size: 378 kB

Filename Size Change
dist/cjs/index.browser.cjs 107 kB +84 B (+0.08%)
dist/cjs/index.node.cjs 151 kB +81 B (+0.05%)
dist/esm/index.js 120 kB +83 B (+0.07%)

compressed-size-action

Copy link
Contributor

@arnautov-anton arnautov-anton left a comment

Choose a reason for hiding this comment

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

🌮

@isekovanic isekovanic marked this pull request as ready for review May 12, 2025 08:16
@isekovanic isekovanic merged commit 23eebf0 into master May 12, 2025
6 checks passed
@isekovanic isekovanic deleted the fix/add-optional-raw-query-channels-response branch May 12, 2025 08:30
github-actions bot pushed a commit that referenced this pull request May 12, 2025
## [9.1.1](v9.1.0...v9.1.1) (2025-05-12)

### Bug Fixes

* add optional raw queryChannels api response ([#1530](#1530)) ([23eebf0](23eebf0))
@stream-ci-bot
Copy link

🎉 This PR is included in version 9.1.1 🎉

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