@reactivex/rxjs
Version:
Reactive Extensions for modern JavaScript
54 lines • 2.15 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
var combineLatest_1 = require("../observable/combineLatest");
/**
* Flattens an Observable-of-Observables by applying {@link combineLatest} when the Observable-of-Observables completes.
*
* 
*
* `combineAll` 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}</a> 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 the most recent values is emitted by the output Observable.
*
* ---
*
* ## Examples
*
* ### Map two click events to a finite interval Observable, then apply `combineAll`
*
* ```ts
* import { fromEvent, interval } from 'rxjs';
* import { map, combineAll, take } from 'rxjs/operators';
*
* const clicks = fromEvent(document, 'click');
* const higherOrder = clicks.pipe(
* map(ev =>
* interval(Math.random() * 2000).pipe(take(3))
* ),
* take(2)
* );
* const result = higherOrder.pipe(
* combineAll()
* );
*
* result.subscribe(x => console.log(x));
* ```
*
* @see {@link combineLatest}
* @see {@link mergeAll}
*
* @param {function(...values: Array<any>)} 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<T>}
* @name combineAll
*/
function combineAll(project) {
return function (source) { return source.lift(new combineLatest_1.CombineLatestOperator(project)); };
}
exports.combineAll = combineAll;
//# sourceMappingURL=combineAll.js.map