1 import { Observable } from '../Observable';
2 import { fromArray } from './fromArray';
3 import { isArray } from '../util/isArray';
4 import { Operator } from '../Operator';
5 import { ObservableInput, PartialObserver, ObservedValueOf } from '../types';
6 import { Subscriber } from '../Subscriber';
7 import { Subscription } from '../Subscription';
8 import { iterator as Symbol_iterator } from '../../internal/symbol/iterator';
9 import { SimpleOuterSubscriber, SimpleInnerSubscriber, innerSubscribe } from '../innerSubscribe';
11 /* tslint:disable:max-line-length */
12 /** @deprecated resultSelector is no longer supported, pipe to map instead */
13 export function zip<O1 extends ObservableInput<any>, R>(v1: O1, resultSelector: (v1: ObservedValueOf<O1>) => R): Observable<R>;
14 /** @deprecated resultSelector is no longer supported, pipe to map instead */
15 export function zip<O1 extends ObservableInput<any>, O2 extends ObservableInput<any>, R>(v1: O1, v2: O2, resultSelector: (v1: ObservedValueOf<O1>, v2: ObservedValueOf<O2>) => R): Observable<R>;
16 /** @deprecated resultSelector is no longer supported, pipe to map instead */
17 export function zip<O1 extends ObservableInput<any>, O2 extends ObservableInput<any>, O3 extends ObservableInput<any>, R>(v1: O1, v2: O2, v3: O3, resultSelector: (v1: ObservedValueOf<O1>, v2: ObservedValueOf<O2>, v3: ObservedValueOf<O3>) => R): Observable<R>;
18 /** @deprecated resultSelector is no longer supported, pipe to map instead */
19 export function zip<O1 extends ObservableInput<any>, O2 extends ObservableInput<any>, O3 extends ObservableInput<any>, O4 extends ObservableInput<any>, R>(v1: O1, v2: O2, v3: O3, v4: O4, resultSelector: (v1: ObservedValueOf<O1>, v2: ObservedValueOf<O2>, v3: ObservedValueOf<O3>, v4: ObservedValueOf<O4>) => R): Observable<R>;
20 /** @deprecated resultSelector is no longer supported, pipe to map instead */
21 export function zip<O1 extends ObservableInput<any>, O2 extends ObservableInput<any>, O3 extends ObservableInput<any>, O4 extends ObservableInput<any>, O5 extends ObservableInput<any>, R>(v1: O1, v2: O2, v3: O3, v4: O4, v5: O5, resultSelector: (v1: ObservedValueOf<O1>, v2: ObservedValueOf<O2>, v3: ObservedValueOf<O3>, v4: ObservedValueOf<O4>, v5: ObservedValueOf<O5>) => R): Observable<R>;
22 /** @deprecated resultSelector is no longer supported, pipe to map instead */
23 export function zip<O1 extends ObservableInput<any>, O2 extends ObservableInput<any>, O3 extends ObservableInput<any>, O4 extends ObservableInput<any>, O5 extends ObservableInput<any>, O6 extends ObservableInput<any>, R>(v1: O1, v2: O2, v3: O3, v4: O4, v5: O5, v6: O6, resultSelector: (v1: ObservedValueOf<O1>, v2: ObservedValueOf<O2>, v3: ObservedValueOf<O3>, v4: ObservedValueOf<O4>, v5: ObservedValueOf<O5>, v6: ObservedValueOf<O6>) => R): Observable<R>;
25 export function zip<O1 extends ObservableInput<any>, O2 extends ObservableInput<any>>(v1: O1, v2: O2): Observable<[ObservedValueOf<O1>, ObservedValueOf<O2>]>;
26 export function zip<O1 extends ObservableInput<any>, O2 extends ObservableInput<any>, O3 extends ObservableInput<any>>(v1: O1, v2: O2, v3: O3): Observable<[ObservedValueOf<O1>, ObservedValueOf<O2>, ObservedValueOf<O3>]>;
27 export function zip<O1 extends ObservableInput<any>, O2 extends ObservableInput<any>, O3 extends ObservableInput<any>, O4 extends ObservableInput<any>>(v1: O1, v2: O2, v3: O3, v4: O4): Observable<[ObservedValueOf<O1>, ObservedValueOf<O2>, ObservedValueOf<O3>, ObservedValueOf<O4>]>;
28 export function zip<O1 extends ObservableInput<any>, O2 extends ObservableInput<any>, O3 extends ObservableInput<any>, O4 extends ObservableInput<any>, O5 extends ObservableInput<any>>(v1: O1, v2: O2, v3: O3, v4: O4, v5: O5): Observable<[ObservedValueOf<O1>, ObservedValueOf<O2>, ObservedValueOf<O3>, ObservedValueOf<O4>, ObservedValueOf<O5>]>;
29 export function zip<O1 extends ObservableInput<any>, O2 extends ObservableInput<any>, O3 extends ObservableInput<any>, O4 extends ObservableInput<any>, O5 extends ObservableInput<any>, O6 extends ObservableInput<any>>(v1: O1, v2: O2, v3: O3, v4: O4, v5: O5, v6: O6): Observable<[ObservedValueOf<O1>, ObservedValueOf<O2>, ObservedValueOf<O3>, ObservedValueOf<O4>, ObservedValueOf<O5>, ObservedValueOf<O6>]>;
31 export function zip<O extends ObservableInput<any>>(array: O[]): Observable<ObservedValueOf<O>[]>;
32 export function zip<R>(array: ObservableInput<any>[]): Observable<R>;
33 /** @deprecated resultSelector is no longer supported, pipe to map instead */
34 export function zip<O extends ObservableInput<any>, R>(array: O[], resultSelector: (...values: ObservedValueOf<O>[]) => R): Observable<R>;
35 /** @deprecated resultSelector is no longer supported, pipe to map instead */
36 export function zip<R>(array: ObservableInput<any>[], resultSelector: (...values: any[]) => R): Observable<R>;
38 export function zip<O extends ObservableInput<any>>(...observables: O[]): Observable<ObservedValueOf<O>[]>;
39 export function zip<O extends ObservableInput<any>, R>(...observables: Array<O | ((...values: ObservedValueOf<O>[]) => R)>): Observable<R>;
40 export function zip<R>(...observables: Array<ObservableInput<any> | ((...values: Array<any>) => R)>): Observable<R>;
41 /* tslint:enable:max-line-length */
44 * Combines multiple Observables to create an Observable whose values are calculated from the values, in order, of each
45 * of its input Observables.
47 * If the last parameter is a function, this function is used to compute the created value from the input values.
48 * Otherwise, an array of the input values is returned.
51 * Combine age and name from different sources
53 * import { zip, of } from 'rxjs';
54 * import { map } from 'rxjs/operators';
56 * let age$ = of<number>(27, 25, 29);
57 * let name$ = of<string>('Foo', 'Bar', 'Beer');
58 * let isDev$ = of<boolean>(true, true, false);
60 * zip(age$, name$, isDev$).pipe(
61 * map(([age, name, isDev]) => ({ age, name, isDev })),
63 * .subscribe(x => console.log(x));
66 * // { age: 27, name: 'Foo', isDev: true }
67 * // { age: 25, name: 'Bar', isDev: true }
68 * // { age: 29, name: 'Beer', isDev: false }
71 * @return {Observable<R>}
76 export function zip<O extends ObservableInput<any>, R>(
77 ...observables: Array<O | ((...values: ObservedValueOf<O>[]) => R)>
78 ): Observable<ObservedValueOf<O>[]|R> {
79 const resultSelector = <((...ys: Array<any>) => R)> observables[observables.length - 1];
80 if (typeof resultSelector === 'function') {
83 return fromArray(observables, undefined).lift(new ZipOperator(resultSelector));
86 export class ZipOperator<T, R> implements Operator<T, R> {
88 resultSelector?: (...values: Array<any>) => R;
90 constructor(resultSelector?: (...values: Array<any>) => R) {
91 this.resultSelector = resultSelector;
94 call(subscriber: Subscriber<R>, source: any): any {
95 return source.subscribe(new ZipSubscriber(subscriber, this.resultSelector));
100 * We need this JSDoc comment for affecting ESDoc.
104 export class ZipSubscriber<T, R> extends Subscriber<T> {
105 private iterators: LookAheadIterator<any>[] = [];
108 constructor(destination: Subscriber<R>,
109 private resultSelector?: (...values: Array<any>) => R,
110 values: any = Object.create(null)) {
112 this.resultSelector = (typeof resultSelector === 'function') ? resultSelector : undefined;
115 protected _next(value: any) {
116 const iterators = this.iterators;
117 if (isArray(value)) {
118 iterators.push(new StaticArrayIterator(value));
119 } else if (typeof value[Symbol_iterator] === 'function') {
120 iterators.push(new StaticIterator(value[Symbol_iterator]()));
122 iterators.push(new ZipBufferIterator(this.destination, this, value));
126 protected _complete() {
127 const iterators = this.iterators;
128 const len = iterators.length;
133 this.destination.complete!();
138 for (let i = 0; i < len; i++) {
139 let iterator: ZipBufferIterator<any, any> = <any>iterators[i];
140 if (iterator.stillUnsubscribed) {
141 const destination = this.destination as Subscription;
142 destination.add(iterator.subscribe());
144 this.active--; // not an observable
151 if (this.active === 0) {
152 this.destination.complete!();
157 const iterators = this.iterators;
158 const len = iterators.length;
159 const destination = this.destination;
161 // abort if not all of them have values
162 for (let i = 0; i < len; i++) {
163 let iterator = iterators[i];
164 if (typeof iterator.hasValue === 'function' && !iterator.hasValue()) {
169 let shouldComplete = false;
170 const args: any[] = [];
171 for (let i = 0; i < len; i++) {
172 let iterator = iterators[i];
173 let result = iterator.next();
175 // check to see if it's completed now that you've gotten
177 if (iterator.hasCompleted()) {
178 shouldComplete = true;
182 destination.complete!();
186 args.push(result.value);
189 if (this.resultSelector) {
190 this._tryresultSelector(args);
192 destination.next!(args);
195 if (shouldComplete) {
196 destination.complete!();
200 protected _tryresultSelector(args: any[]) {
203 result = this.resultSelector!.apply(this, args);
205 this.destination.error!(err);
208 this.destination.next!(result);
212 interface LookAheadIterator<T> extends Iterator<T> {
214 hasCompleted(): boolean;
217 class StaticIterator<T> implements LookAheadIterator<T> {
218 private nextResult: IteratorResult<T>;
220 constructor(private iterator: Iterator<T>) {
221 this.nextResult = iterator.next();
228 next(): IteratorResult<T> {
229 const result = this.nextResult;
230 this.nextResult = this.iterator.next();
234 hasCompleted(): boolean {
235 const nextResult = this.nextResult;
236 return Boolean(nextResult && nextResult.done);
240 class StaticArrayIterator<T> implements LookAheadIterator<T> {
244 constructor(private array: T[]) {
245 this.length = array.length;
248 [Symbol_iterator]() {
252 next(value?: any): IteratorResult<T> {
253 const i = this.index++;
254 const array = this.array;
255 return i < this.length ? { value: array[i], done: false } : { value: null, done: true };
259 return this.array.length > this.index;
263 return this.array.length === this.index;
268 * We need this JSDoc comment for affecting ESDoc.
272 class ZipBufferIterator<T, R> extends SimpleOuterSubscriber<T, R> implements LookAheadIterator<T> {
273 stillUnsubscribed = true;
277 constructor(destination: PartialObserver<T>,
278 private parent: ZipSubscriber<T, R>,
279 private observable: Observable<T>) {
283 [Symbol_iterator]() {
287 // NOTE: there is actually a name collision here with Subscriber.next and Iterator.next
288 // this is legit because `next()` will never be called by a subscription in this case.
289 next(): IteratorResult<T> {
290 const buffer = this.buffer;
291 if (buffer.length === 0 && this.isComplete) {
292 return { value: null, done: true };
294 return { value: buffer.shift()!, done: false };
299 return this.buffer.length > 0;
303 return this.buffer.length === 0 && this.isComplete;
307 if (this.buffer.length > 0) {
308 this.isComplete = true;
309 this.parent.notifyInactive();
311 this.destination.complete!();
315 notifyNext(innerValue: any): void {
316 this.buffer.push(innerValue);
317 this.parent.checkIterators();
321 return innerSubscribe(this.observable, new SimpleInnerSubscriber(this));