import { Observable } from '../Observable'; import { fromArray } from './fromArray'; import { isArray } from '../util/isArray'; import { Operator } from '../Operator'; import { ObservableInput, PartialObserver, ObservedValueOf } from '../types'; import { Subscriber } from '../Subscriber'; import { Subscription } from '../Subscription'; import { iterator as Symbol_iterator } from '../../internal/symbol/iterator'; import { SimpleOuterSubscriber, SimpleInnerSubscriber, innerSubscribe } from '../innerSubscribe'; /* tslint:disable:max-line-length */ /** @deprecated resultSelector is no longer supported, pipe to map instead */ export function zip, R>(v1: O1, resultSelector: (v1: ObservedValueOf) => R): Observable; /** @deprecated resultSelector is no longer supported, pipe to map instead */ export function zip, O2 extends ObservableInput, R>(v1: O1, v2: O2, resultSelector: (v1: ObservedValueOf, v2: ObservedValueOf) => R): Observable; /** @deprecated resultSelector is no longer supported, pipe to map instead */ export function zip, O2 extends ObservableInput, O3 extends ObservableInput, R>(v1: O1, v2: O2, v3: O3, resultSelector: (v1: ObservedValueOf, v2: ObservedValueOf, v3: ObservedValueOf) => R): Observable; /** @deprecated resultSelector is no longer supported, pipe to map instead */ export function zip, O2 extends ObservableInput, O3 extends ObservableInput, O4 extends ObservableInput, R>(v1: O1, v2: O2, v3: O3, v4: O4, resultSelector: (v1: ObservedValueOf, v2: ObservedValueOf, v3: ObservedValueOf, v4: ObservedValueOf) => R): Observable; /** @deprecated resultSelector is no longer supported, pipe to map instead */ export function zip, O2 extends ObservableInput, O3 extends ObservableInput, O4 extends ObservableInput, O5 extends ObservableInput, R>(v1: O1, v2: O2, v3: O3, v4: O4, v5: O5, resultSelector: (v1: ObservedValueOf, v2: ObservedValueOf, v3: ObservedValueOf, v4: ObservedValueOf, v5: ObservedValueOf) => R): Observable; /** @deprecated resultSelector is no longer supported, pipe to map instead */ export function zip, O2 extends ObservableInput, O3 extends ObservableInput, O4 extends ObservableInput, O5 extends ObservableInput, O6 extends ObservableInput, R>(v1: O1, v2: O2, v3: O3, v4: O4, v5: O5, v6: O6, resultSelector: (v1: ObservedValueOf, v2: ObservedValueOf, v3: ObservedValueOf, v4: ObservedValueOf, v5: ObservedValueOf, v6: ObservedValueOf) => R): Observable; export function zip, O2 extends ObservableInput>(v1: O1, v2: O2): Observable<[ObservedValueOf, ObservedValueOf]>; export function zip, O2 extends ObservableInput, O3 extends ObservableInput>(v1: O1, v2: O2, v3: O3): Observable<[ObservedValueOf, ObservedValueOf, ObservedValueOf]>; export function zip, O2 extends ObservableInput, O3 extends ObservableInput, O4 extends ObservableInput>(v1: O1, v2: O2, v3: O3, v4: O4): Observable<[ObservedValueOf, ObservedValueOf, ObservedValueOf, ObservedValueOf]>; export function zip, O2 extends ObservableInput, O3 extends ObservableInput, O4 extends ObservableInput, O5 extends ObservableInput>(v1: O1, v2: O2, v3: O3, v4: O4, v5: O5): Observable<[ObservedValueOf, ObservedValueOf, ObservedValueOf, ObservedValueOf, ObservedValueOf]>; export function zip, O2 extends ObservableInput, O3 extends ObservableInput, O4 extends ObservableInput, O5 extends ObservableInput, O6 extends ObservableInput>(v1: O1, v2: O2, v3: O3, v4: O4, v5: O5, v6: O6): Observable<[ObservedValueOf, ObservedValueOf, ObservedValueOf, ObservedValueOf, ObservedValueOf, ObservedValueOf]>; export function zip>(array: O[]): Observable[]>; export function zip(array: ObservableInput[]): Observable; /** @deprecated resultSelector is no longer supported, pipe to map instead */ export function zip, R>(array: O[], resultSelector: (...values: ObservedValueOf[]) => R): Observable; /** @deprecated resultSelector is no longer supported, pipe to map instead */ export function zip(array: ObservableInput[], resultSelector: (...values: any[]) => R): Observable; export function zip>(...observables: O[]): Observable[]>; export function zip, R>(...observables: Array[]) => R)>): Observable; export function zip(...observables: Array | ((...values: Array) => R)>): Observable; /* tslint:enable:max-line-length */ /** * Combines multiple Observables to create an Observable whose values are calculated from the values, in order, of each * of its input Observables. * * If the last parameter is a function, this function is used to compute the created value from the input values. * Otherwise, an array of the input values is returned. * * ## Example * Combine age and name from different sources * ```ts * import { zip, of } from 'rxjs'; * import { map } from 'rxjs/operators'; * * let age$ = of(27, 25, 29); * let name$ = of('Foo', 'Bar', 'Beer'); * let isDev$ = of(true, true, false); * * zip(age$, name$, isDev$).pipe( * map(([age, name, isDev]) => ({ age, name, isDev })), * ) * .subscribe(x => console.log(x)); * * // outputs * // { age: 27, name: 'Foo', isDev: true } * // { age: 25, name: 'Bar', isDev: true } * // { age: 29, name: 'Beer', isDev: false } * ``` * @param observables * @return {Observable} * @static true * @name zip * @owner Observable */ export function zip, R>( ...observables: Array[]) => R)> ): Observable[]|R> { const resultSelector = <((...ys: Array) => R)> observables[observables.length - 1]; if (typeof resultSelector === 'function') { observables.pop(); } return fromArray(observables, undefined).lift(new ZipOperator(resultSelector)); } export class ZipOperator implements Operator { resultSelector?: (...values: Array) => R; constructor(resultSelector?: (...values: Array) => R) { this.resultSelector = resultSelector; } call(subscriber: Subscriber, source: any): any { return source.subscribe(new ZipSubscriber(subscriber, this.resultSelector)); } } /** * We need this JSDoc comment for affecting ESDoc. * @ignore * @extends {Ignored} */ export class ZipSubscriber extends Subscriber { private iterators: LookAheadIterator[] = []; private active = 0; constructor(destination: Subscriber, private resultSelector?: (...values: Array) => R, values: any = Object.create(null)) { super(destination); this.resultSelector = (typeof resultSelector === 'function') ? resultSelector : undefined; } protected _next(value: any) { const iterators = this.iterators; if (isArray(value)) { iterators.push(new StaticArrayIterator(value)); } else if (typeof value[Symbol_iterator] === 'function') { iterators.push(new StaticIterator(value[Symbol_iterator]())); } else { iterators.push(new ZipBufferIterator(this.destination, this, value)); } } protected _complete() { const iterators = this.iterators; const len = iterators.length; this.unsubscribe(); if (len === 0) { this.destination.complete!(); return; } this.active = len; for (let i = 0; i < len; i++) { let iterator: ZipBufferIterator = iterators[i]; if (iterator.stillUnsubscribed) { const destination = this.destination as Subscription; destination.add(iterator.subscribe()); } else { this.active--; // not an observable } } } notifyInactive() { this.active--; if (this.active === 0) { this.destination.complete!(); } } checkIterators() { const iterators = this.iterators; const len = iterators.length; const destination = this.destination; // abort if not all of them have values for (let i = 0; i < len; i++) { let iterator = iterators[i]; if (typeof iterator.hasValue === 'function' && !iterator.hasValue()) { return; } } let shouldComplete = false; const args: any[] = []; for (let i = 0; i < len; i++) { let iterator = iterators[i]; let result = iterator.next(); // check to see if it's completed now that you've gotten // the next value. if (iterator.hasCompleted()) { shouldComplete = true; } if (result.done) { destination.complete!(); return; } args.push(result.value); } if (this.resultSelector) { this._tryresultSelector(args); } else { destination.next!(args); } if (shouldComplete) { destination.complete!(); } } protected _tryresultSelector(args: any[]) { let result: any; try { result = this.resultSelector!.apply(this, args); } catch (err) { this.destination.error!(err); return; } this.destination.next!(result); } } interface LookAheadIterator extends Iterator { hasValue(): boolean; hasCompleted(): boolean; } class StaticIterator implements LookAheadIterator { private nextResult: IteratorResult; constructor(private iterator: Iterator) { this.nextResult = iterator.next(); } hasValue() { return true; } next(): IteratorResult { const result = this.nextResult; this.nextResult = this.iterator.next(); return result; } hasCompleted(): boolean { const nextResult = this.nextResult; return Boolean(nextResult && nextResult.done); } } class StaticArrayIterator implements LookAheadIterator { private index = 0; private length = 0; constructor(private array: T[]) { this.length = array.length; } [Symbol_iterator]() { return this; } next(value?: any): IteratorResult { const i = this.index++; const array = this.array; return i < this.length ? { value: array[i], done: false } : { value: null, done: true }; } hasValue() { return this.array.length > this.index; } hasCompleted() { return this.array.length === this.index; } } /** * We need this JSDoc comment for affecting ESDoc. * @ignore * @extends {Ignored} */ class ZipBufferIterator extends SimpleOuterSubscriber implements LookAheadIterator { stillUnsubscribed = true; buffer: T[] = []; isComplete = false; constructor(destination: PartialObserver, private parent: ZipSubscriber, private observable: Observable) { super(destination); } [Symbol_iterator]() { return this; } // NOTE: there is actually a name collision here with Subscriber.next and Iterator.next // this is legit because `next()` will never be called by a subscription in this case. next(): IteratorResult { const buffer = this.buffer; if (buffer.length === 0 && this.isComplete) { return { value: null, done: true }; } else { return { value: buffer.shift()!, done: false }; } } hasValue() { return this.buffer.length > 0; } hasCompleted() { return this.buffer.length === 0 && this.isComplete; } notifyComplete() { if (this.buffer.length > 0) { this.isComplete = true; this.parent.notifyInactive(); } else { this.destination.complete!(); } } notifyNext(innerValue: any): void { this.buffer.push(innerValue); this.parent.checkIterators(); } subscribe() { return innerSubscribe(this.observable, new SimpleInnerSubscriber(this)); } }