Document Swift includeDefaultStreams option#413
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Conversation
Generated-By: mintlify-agent
simolus3
requested changes
Apr 29, 2026
Contributor
simolus3
left a comment
simolus3
left a comment
There was a problem hiding this comment.
We have that option on all our SDKs now, only Swift didn't have this before.
I think it could make sense to add a note to client-usage.mdx about that option being available on connect() though.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Swift SDK now drives the streaming sync client natively from Swift, and exposes a new
includeDefaultStreamsflag onConnectOptions. When set tofalse, streams defined withauto_subscribe: truewill not sync unless the client explicitly subscribes to them. The default remainstrue, so existing behavior is unchanged.Changes
sync/streams/client-usage.mdx: Added an "Opting Out of Auto-Subscribed Streams" section with a Swift example showingConnectOptions(includeDefaultStreams: false).sync/streams/overview.mdx: Added a callout in the auto-subscribe section pointing Swift users to the new option.Triggering PR
Documents the user-facing change from the merged Swift SDK PR that adds an
includeDefaultStreamsfield toConnectOptions. The rest of that PR is an internal refactor (the Swift SDK now talks directly to the sync protocol instead of going through the Kotlin layer), with no other user-facing API surface.cc @benitav @simolus3 for review.