43 lines
2.0 KiB
TypeScript
43 lines
2.0 KiB
TypeScript
|
import { Observable } from '../Observable';
|
||
|
|
/**
|
||
|
|
* Converts a higher-order Observable into a first-order Observable by waiting
|
||
|
|
* for the outer Observable to complete, then applying {@link combineLatest}.
|
||
|
|
*
|
||
|
|
* <span class="informal">Flattens an Observable-of-Observables by applying
|
||
|
|
* {@link combineLatest} when the Observable-of-Observables completes.</span>
|
||
|
|
*
|
||
|
|
* <img src="./img/combineAll.png" width="100%">
|
||
|
|
*
|
||
|
|
* Takes an Observable of Observables, and collects all Observables from it.
|
||
|
|
* Once the outer Observable completes, it subscribes to all collected
|
||
|
|
* Observables and combines their values using the {@link combineLatest}
|
||
|
|
* strategy, such that:
|
||
|
|
* - Every time an inner Observable emits, the output Observable emits.
|
||
|
|
* - When the returned observable emits, it emits all of the latest values by:
|
||
|
|
* - If a `project` function is provided, it is called with each recent value
|
||
|
|
* from each inner Observable in whatever order they arrived, and the result
|
||
|
|
* of the `project` function is what is emitted by the output Observable.
|
||
|
|
* - If there is no `project` function, an array of all of the most recent
|
||
|
|
* values is emitted by the output Observable.
|
||
|
|
*
|
||
|
|
* @example <caption>Map two click events to a finite interval Observable, then apply combineAll</caption>
|
||
|
|
* var clicks = Rx.Observable.fromEvent(document, 'click');
|
||
|
|
* var higherOrder = clicks.map(ev =>
|
||
|
|
* Rx.Observable.interval(Math.random()*2000).take(3)
|
||
|
|
* ).take(2);
|
||
|
|
* var result = higherOrder.combineAll();
|
||
|
|
* result.subscribe(x => console.log(x));
|
||
|
|
*
|
||
|
|
* @see {@link combineLatest}
|
||
|
|
* @see {@link mergeAll}
|
||
|
|
*
|
||
|
|
* @param {function} [project] An optional function to map the most recent
|
||
|
|
* values from each inner Observable into a new result. Takes each of the most
|
||
|
|
* recent values from each collected inner Observable as arguments, in order.
|
||
|
|
* @return {Observable} An Observable of projected results or arrays of recent
|
||
|
|
* values.
|
||
|
|
* @method combineAll
|
||
|
|
* @owner Observable
|
||
|
|
*/
|
||
|
|
export declare function combineAll<T, R>(this: Observable<T>, project?: (...values: Array<any>) => R): Observable<R>;
|