UNPKG

rxjs-compat

Version:

[![CircleCI](https://circleci.com/gh/ReactiveX/rxjs/tree/6.x.svg?style=svg)](https://circleci.com/gh/ReactiveX/rxjs/tree/6.x) [![npm version](https://badge.fury.io/js/%40reactivex%2Frxjs.svg)](http://badge.fury.io/js/%40reactivex%2Frxjs) [![Join the chat

37 lines (36 loc) 1.52 kB
import { Observable } from 'rxjs'; /** * Emits the values emitted by the source Observable until a `notifier` * Observable emits a value. * * <span class="informal">Lets values pass until a second Observable, * `notifier`, emits a value. Then, it completes.</span> * * <img src="./img/takeUntil.png" width="100%"> * * `takeUntil` subscribes and begins mirroring the source Observable. It also * monitors a second Observable, `notifier` that you provide. If the `notifier` * emits a value, the output Observable stops mirroring the source Observable * and completes. If the `notifier` doesn't emit any value and completes * then `takeUntil` will pass all values. * * @example <caption>Tick every second until the first click happens</caption> * var interval = Rx.Observable.interval(1000); * var clicks = Rx.Observable.fromEvent(document, 'click'); * var result = interval.takeUntil(clicks); * result.subscribe(x => console.log(x)); * * @see {@link take} * @see {@link takeLast} * @see {@link takeWhile} * @see {@link skip} * * @param {Observable} notifier The Observable whose first emitted value will * cause the output Observable of `takeUntil` to stop emitting values from the * source Observable. * @return {Observable<T>} An Observable that emits the values from the source * Observable until such time as `notifier` emits its first value. * @method takeUntil * @owner Observable */ export declare function takeUntil<T>(this: Observable<T>, notifier: Observable<any>): Observable<T>;