Skip to content

Commit e803404

Browse files
patmaltfreak4pc
authored andcommitted
Update Readme for bufferWithTrigger
1 parent 59aec0f commit e803404

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

Playground/RxSwiftExtPlayground.playground/Pages/bufferWithTrigger.xcplaygroundpage/Contents.swift

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import RxSwiftExt
1313
/*:
1414
## bufferWithTrigger
1515

16-
Collects the elements of the source observable, and emits them as an array when the boundary emits.
16+
Collects the elements of the source observable, and emits them as an array when the trigger emits.
1717
*/
1818

1919
example("bufferWithTrigger") {
@@ -23,10 +23,7 @@ example("bufferWithTrigger") {
2323
let signalAtFiveSeconds = Observable<Int>.timer(5, scheduler: MainScheduler.instance).map { _ in () }
2424
let trigger = Observable.of(signalAtThreeSeconds, signalAtFiveSeconds).merge()
2525

26-
// unlimited buffering of values received while paused
27-
let buffered = observable.bufferWithTrigger(trigger)
28-
29-
buffered.subscribe { print($0) }
26+
observable.bufferWithTrigger(trigger).debug("buffer").subscribe()
3027

3128
playgroundShouldContinueIndefinitely()
3229
}

Readme.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -617,7 +617,17 @@ let numbers = Observable
617617
#### bufferWithTrigger
618618
Collects the elements of the source observable, and emits them as an array when the trigger emits.
619619

620-
Examples are available in the project's Playground.
620+
```swift
621+
let observable = Observable<Int>.interval(1, scheduler: MainScheduler.instance)
622+
let signalAtThreeSeconds = Observable<Int>.timer(3, scheduler: MainScheduler.instance).map { _ in () }
623+
let signalAtFiveSeconds = Observable<Int>.timer(5, scheduler: MainScheduler.instance).map { _ in () }
624+
let trigger = Observable.of(signalAtThreeSeconds, signalAtFiveSeconds).merge()
625+
let buffered = observable.bufferWithTrigger(trigger)
626+
buffered.subscribe { print($0) }
627+
// prints next([0, 1, 2]) @ 3, next([3, 4]) @ 5
628+
```
629+
630+
A live demonstration is available in the Playground.
621631

622632
Reactive Extensions details
623633
===========

0 commit comments

Comments
 (0)