rxjs
Version:
Reactive Extensions for modern JavaScript
49 lines • 1.93 kB
TypeScript
import { Observable } from '../Observable';
import { ObservableInput, OperatorFunction } from '../types';
/**
* Branch out the source Observable values as a nested Observable starting from
* an emission from `openings` and ending when the output of `closingSelector`
* emits.
*
* <span class="informal">It's like {@link bufferToggle}, but emits a nested
* Observable instead of an array.</span>
*
* 
*
* Returns an Observable that emits windows of items it collects from the source
* Observable. The output Observable emits windows that contain those items
* emitted by the source Observable between the time when the `openings`
* Observable emits an item and when the Observable returned by
* `closingSelector` emits an item.
*
* ## Example
*
* Every other second, emit the click events from the next 500ms
*
* ```ts
* import { fromEvent, interval, windowToggle, EMPTY, mergeAll } from 'rxjs';
*
* const clicks = fromEvent(document, 'click');
* const openings = interval(1000);
* const result = clicks.pipe(
* windowToggle(openings, i => i % 2 ? interval(500) : EMPTY),
* mergeAll()
* );
* result.subscribe(x => console.log(x));
* ```
*
* @see {@link window}
* @see {@link windowCount}
* @see {@link windowTime}
* @see {@link windowWhen}
* @see {@link bufferToggle}
*
* @param openings An observable of notifications to start new windows.
* @param closingSelector A function that takes the value emitted by the
* `openings` observable and returns an Observable, which, when it emits a next
* notification, signals that the associated window should complete.
* @return A function that returns an Observable of windows, which in turn are
* Observables.
*/
export declare function windowToggle<T, O>(openings: ObservableInput<O>, closingSelector: (openValue: O) => ObservableInput<any>): OperatorFunction<T, Observable<T>>;
//# sourceMappingURL=windowToggle.d.ts.map