Skip to content

Update FlattenStrategy.throttle docs. #770

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.

Sign up for GitHub

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 1 commit into from
Jan 7, 2020
Merged

Update FlattenStrategy.throttle docs. #770

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Sources/Flatten.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,10 @@ public struct FlattenStrategy {
/// stream of values.
public static let race = FlattenStrategy(kind: .race)

/// Forward only events from the "first inner stream" that sends an event if not exists.
/// Other inner streams is disposed of until the first inner stream is completed.
/// Note that next inner stream after previous completion can become
/// first inner stream again.
/// Given a first inner stream, all subsequent inner streams sent by the upstream would
/// be dropped until the first inner stream has completed. The whole process repeats
/// indefinitely until the upstream terminates. The behavior is akin to `throttle(_:on:)`
/// except for operating in the domain of streams instead of time.
///
/// The flattened stream of values completes only when the stream of streams has completed,
/// and first inner stream has completed if exists.
Expand Down