import { Observable } from '../Observable'; import { Operator } from '../Operator'; import { Subscriber } from '../Subscriber'; import { Subscription } from '../Subscription'; import { MonoTypeOperatorFunction, OperatorFunction, ObservableInput, SchedulerLike } from '../types'; import { SimpleOuterSubscriber, innerSubscribe, SimpleInnerSubscriber } from '../innerSubscribe'; /* tslint:disable:max-line-length */ export function expand(project: (value: T, index: number) => ObservableInput, concurrent?: number, scheduler?: SchedulerLike): OperatorFunction; export function expand(project: (value: T, index: number) => ObservableInput, concurrent?: number, scheduler?: SchedulerLike): MonoTypeOperatorFunction; /* tslint:enable:max-line-length */ /** * Recursively projects each source value to an Observable which is merged in * the output Observable. * * It's similar to {@link mergeMap}, but applies the * projection function to every source value as well as every output value. * It's recursive. * * ![](expand.png) * * Returns an Observable that emits items based on applying a function that you * supply to each item emitted by the source Observable, where that function * returns an Observable, and then merging those resulting Observables and * emitting the results of this merger. *Expand* will re-emit on the output * Observable every source value. Then, each output value is given to the * `project` function which returns an inner Observable to be merged on the * output Observable. Those output values resulting from the projection are also * given to the `project` function to produce new output values. This is how * *expand* behaves recursively. * * ## Example * Start emitting the powers of two on every click, at most 10 of them * ```ts * import { fromEvent, of } from 'rxjs'; * import { expand, mapTo, delay, take } from 'rxjs/operators'; * * const clicks = fromEvent(document, 'click'); * const powersOfTwo = clicks.pipe( * mapTo(1), * expand(x => of(2 * x).pipe(delay(1000))), * take(10), * ); * powersOfTwo.subscribe(x => console.log(x)); * ``` * * @see {@link mergeMap} * @see {@link mergeScan} * * @param {function(value: T, index: number) => Observable} project A function * that, when applied to an item emitted by the source or the output Observable, * returns an Observable. * @param {number} [concurrent=Number.POSITIVE_INFINITY] Maximum number of input * Observables being subscribed to concurrently. * @param {SchedulerLike} [scheduler=null] The {@link SchedulerLike} to use for subscribing to * each projected inner Observable. * @return {Observable} An Observable that emits the source values and also * result of applying the projection function to each value emitted on the * output Observable and and merging the results of the Observables obtained * from this transformation. * @method expand * @owner Observable */ export function expand(project: (value: T, index: number) => ObservableInput, concurrent: number = Number.POSITIVE_INFINITY, scheduler?: SchedulerLike): OperatorFunction { concurrent = (concurrent || 0) < 1 ? Number.POSITIVE_INFINITY : concurrent; return (source: Observable) => source.lift(new ExpandOperator(project, concurrent, scheduler)); } export class ExpandOperator implements Operator { constructor(private project: (value: T, index: number) => ObservableInput, private concurrent: number, private scheduler?: SchedulerLike) { } call(subscriber: Subscriber, source: any): any { return source.subscribe(new ExpandSubscriber(subscriber, this.project, this.concurrent, this.scheduler)); } } interface DispatchArg { subscriber: ExpandSubscriber; result: ObservableInput; value: any; index: number; } /** * We need this JSDoc comment for affecting ESDoc. * @ignore * @extends {Ignored} */ export class ExpandSubscriber extends SimpleOuterSubscriber { private index: number = 0; private active: number = 0; private hasCompleted: boolean = false; private buffer?: any[]; constructor(destination: Subscriber, private project: (value: T, index: number) => ObservableInput, private concurrent: number, private scheduler?: SchedulerLike) { super(destination); if (concurrent < Number.POSITIVE_INFINITY) { this.buffer = []; } } private static dispatch(arg: DispatchArg): void { const {subscriber, result, value, index} = arg; subscriber.subscribeToProjection(result, value, index); } protected _next(value: any): void { const destination = this.destination; if (destination.closed) { this._complete(); return; } const index = this.index++; if (this.active < this.concurrent) { destination.next!(value); try { const { project } = this; const result = project(value, index); if (!this.scheduler) { this.subscribeToProjection(result, value, index); } else { const state: DispatchArg = { subscriber: this, result, value, index }; const destination = this.destination as Subscription; destination.add(this.scheduler.schedule>(ExpandSubscriber.dispatch as any, 0, state)); } } catch (e) { destination.error!(e); } } else { this.buffer!.push(value); } } private subscribeToProjection(result: any, value: T, index: number): void { this.active++; const destination = this.destination as Subscription; destination.add(innerSubscribe(result, new SimpleInnerSubscriber(this))); } protected _complete(): void { this.hasCompleted = true; if (this.hasCompleted && this.active === 0) { this.destination.complete!(); } this.unsubscribe(); } notifyNext(innerValue: R): void { this._next(innerValue); } notifyComplete(): void { const buffer = this.buffer; this.active--; if (buffer && buffer.length > 0) { this._next(buffer.shift()); } if (this.hasCompleted && this.active === 0) { this.destination.complete!(); } } }