Skip to content

Commit 27a7df9

Browse files
martinsikstaltz
authored andcommitted
docs(takeUntil): update docs to match operator's behavior
2160
1 parent 1f55dad commit 27a7df9

3 files changed

Lines changed: 8 additions & 6 deletions

File tree

doc/decision-tree-widget/tree.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ children:
4343
- label: based on a given amount
4444
children:
4545
- label: takeLast
46-
- label: until another Observable emits a value or completes
46+
- label: until another Observable emits a value
4747
children:
4848
- label: takeUntil
4949
- label: I want to ignore values

src/operator/takeUntil.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ import { takeUntil as higherOrder } from '../operators/takeUntil';
66
* Observable emits a value.
77
*
88
* <span class="informal">Lets values pass until a second Observable,
9-
* `notifier`, emits something. Then, it completes.</span>
9+
* `notifier`, emits a value. Then, it completes.</span>
1010
*
1111
* <img src="./img/takeUntil.png" width="100%">
1212
*
1313
* `takeUntil` subscribes and begins mirroring the source Observable. It also
1414
* monitors a second Observable, `notifier` that you provide. If the `notifier`
1515
* emits a value, the output Observable stops mirroring the source Observable
16-
* and completes.
16+
* and completes. If the `notifier` doesn't emit any value and completes
17+
* then `takeUntil` will pass all values.
1718
*
1819
* @example <caption>Tick every second until the first click happens</caption>
1920
* var interval = Rx.Observable.interval(1000);

src/operators/takeUntil.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,15 @@ import { MonoTypeOperatorFunction } from '../interfaces';
1414
* Observable emits a value.
1515
*
1616
* <span class="informal">Lets values pass until a second Observable,
17-
* `notifier`, emits something. Then, it completes.</span>
17+
* `notifier`, emits a value. Then, it completes.</span>
1818
*
1919
* <img src="./img/takeUntil.png" width="100%">
2020
*
2121
* `takeUntil` subscribes and begins mirroring the source Observable. It also
2222
* monitors a second Observable, `notifier` that you provide. If the `notifier`
23-
* emits a value or a complete notification, the output Observable stops
24-
* mirroring the source Observable and completes.
23+
* emits a value, the output Observable stops mirroring the source Observable
24+
* and completes. If the `notifier` doesn't emit any value and completes
25+
* then `takeUntil` will pass all values.
2526
*
2627
* @example <caption>Tick every second until the first click happens</caption>
2728
* var interval = Rx.Observable.interval(1000);

0 commit comments

Comments
 (0)