fbe0756573b1d6f49bd2c2d1dd2769e61c0795f4
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / rxjs / src / internal / observable / zip.ts
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 { OuterSubscriber } from '../OuterSubscriber';
9 import { InnerSubscriber } from '../InnerSubscriber';
10 import { subscribeToResult } from '../util/subscribeToResult';
11 import { iterator as Symbol_iterator } from '../../internal/symbol/iterator';
12
13 /* tslint:disable:max-line-length */
14 /** @deprecated resultSelector is no longer supported, pipe to map instead */
15 export function zip<O1 extends ObservableInput<any>, R>(v1: O1, resultSelector: (v1: ObservedValueOf<O1>) => 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>, R>(v1: O1, v2: O2, resultSelector: (v1: ObservedValueOf<O1>, v2: ObservedValueOf<O2>) => 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>, R>(v1: O1, v2: O2, v3: O3, resultSelector: (v1: ObservedValueOf<O1>, v2: ObservedValueOf<O2>, v3: ObservedValueOf<O3>) => 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>, 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>;
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>, 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>;
24 /** @deprecated resultSelector is no longer supported, pipe to map instead */
25 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>;
26
27 export function zip<O1 extends ObservableInput<any>, O2 extends ObservableInput<any>>(v1: O1, v2: O2): Observable<[ObservedValueOf<O1>, ObservedValueOf<O2>]>;
28 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>]>;
29 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>]>;
30 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>]>;
31 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>]>;
32
33 export function zip<O extends ObservableInput<any>>(array: O[]): Observable<ObservedValueOf<O>[]>;
34 export function zip<R>(array: ObservableInput<any>[]): Observable<R>;
35 /** @deprecated resultSelector is no longer supported, pipe to map instead */
36 export function zip<O extends ObservableInput<any>, R>(array: O[], resultSelector: (...values: ObservedValueOf<O>[]) => R): Observable<R>;
37 /** @deprecated resultSelector is no longer supported, pipe to map instead */
38 export function zip<R>(array: ObservableInput<any>[], resultSelector: (...values: any[]) => R): Observable<R>;
39
40 export function zip<O extends ObservableInput<any>>(...observables: O[]): Observable<ObservedValueOf<O>[]>;
41 export function zip<O extends ObservableInput<any>, R>(...observables: Array<O | ((...values: ObservedValueOf<O>[]) => R)>): Observable<R>;
42 export function zip<R>(...observables: Array<ObservableInput<any> | ((...values: Array<any>) => R)>): Observable<R>;
43 /* tslint:enable:max-line-length */
44
45 /**
46  * Combines multiple Observables to create an Observable whose values are calculated from the values, in order, of each
47  * of its input Observables.
48  *
49  * If the last parameter is a function, this function is used to compute the created value from the input values.
50  * Otherwise, an array of the input values is returned.
51  *
52  * ## Example
53  * Combine age and name from different sources
54  * ```ts
55  * import { zip, of } from 'rxjs';
56  * import { map } from 'rxjs/operators';
57  *
58  * let age$ = of<number>(27, 25, 29);
59  * let name$ = of<string>('Foo', 'Bar', 'Beer');
60  * let isDev$ = of<boolean>(true, true, false);
61  *
62  * zip(age$, name$, isDev$).pipe(
63  *   map(([age, name, isDev]) => ({ age, name, isDev })),
64  * )
65  * .subscribe(x => console.log(x));
66  *
67  * // outputs
68  * // { age: 27, name: 'Foo', isDev: true }
69  * // { age: 25, name: 'Bar', isDev: true }
70  * // { age: 29, name: 'Beer', isDev: false }
71  * ```
72  * @param observables
73  * @return {Observable<R>}
74  * @static true
75  * @name zip
76  * @owner Observable
77  */
78 export function zip<O extends ObservableInput<any>, R>(
79   ...observables: Array<O | ((...values: ObservedValueOf<O>[]) => R)>
80 ): Observable<ObservedValueOf<O>[]|R> {
81   const resultSelector = <((...ys: Array<any>) => R)> observables[observables.length - 1];
82   if (typeof resultSelector === 'function') {
83     observables.pop();
84   }
85   return fromArray(observables, undefined).lift(new ZipOperator(resultSelector));
86 }
87
88 export class ZipOperator<T, R> implements Operator<T, R> {
89
90   resultSelector: (...values: Array<any>) => R;
91
92   constructor(resultSelector?: (...values: Array<any>) => R) {
93     this.resultSelector = resultSelector;
94   }
95
96   call(subscriber: Subscriber<R>, source: any): any {
97     return source.subscribe(new ZipSubscriber(subscriber, this.resultSelector));
98   }
99 }
100
101 /**
102  * We need this JSDoc comment for affecting ESDoc.
103  * @ignore
104  * @extends {Ignored}
105  */
106 export class ZipSubscriber<T, R> extends Subscriber<T> {
107   private values: any;
108   private resultSelector: (...values: Array<any>) => R;
109   private iterators: LookAheadIterator<any>[] = [];
110   private active = 0;
111
112   constructor(destination: Subscriber<R>,
113               resultSelector?: (...values: Array<any>) => R,
114               values: any = Object.create(null)) {
115     super(destination);
116     this.resultSelector = (typeof resultSelector === 'function') ? resultSelector : null;
117     this.values = values;
118   }
119
120   protected _next(value: any) {
121     const iterators = this.iterators;
122     if (isArray(value)) {
123       iterators.push(new StaticArrayIterator(value));
124     } else if (typeof value[Symbol_iterator] === 'function') {
125       iterators.push(new StaticIterator(value[Symbol_iterator]()));
126     } else {
127       iterators.push(new ZipBufferIterator(this.destination, this, value));
128     }
129   }
130
131   protected _complete() {
132     const iterators = this.iterators;
133     const len = iterators.length;
134
135     this.unsubscribe();
136
137     if (len === 0) {
138       this.destination.complete();
139       return;
140     }
141
142     this.active = len;
143     for (let i = 0; i < len; i++) {
144       let iterator: ZipBufferIterator<any, any> = <any>iterators[i];
145       if (iterator.stillUnsubscribed) {
146         const destination = this.destination as Subscription;
147         destination.add(iterator.subscribe(iterator, i));
148       } else {
149         this.active--; // not an observable
150       }
151     }
152   }
153
154   notifyInactive() {
155     this.active--;
156     if (this.active === 0) {
157       this.destination.complete();
158     }
159   }
160
161   checkIterators() {
162     const iterators = this.iterators;
163     const len = iterators.length;
164     const destination = this.destination;
165
166     // abort if not all of them have values
167     for (let i = 0; i < len; i++) {
168       let iterator = iterators[i];
169       if (typeof iterator.hasValue === 'function' && !iterator.hasValue()) {
170         return;
171       }
172     }
173
174     let shouldComplete = false;
175     const args: any[] = [];
176     for (let i = 0; i < len; i++) {
177       let iterator = iterators[i];
178       let result = iterator.next();
179
180       // check to see if it's completed now that you've gotten
181       // the next value.
182       if (iterator.hasCompleted()) {
183         shouldComplete = true;
184       }
185
186       if (result.done) {
187         destination.complete();
188         return;
189       }
190
191       args.push(result.value);
192     }
193
194     if (this.resultSelector) {
195       this._tryresultSelector(args);
196     } else {
197       destination.next(args);
198     }
199
200     if (shouldComplete) {
201       destination.complete();
202     }
203   }
204
205   protected _tryresultSelector(args: any[]) {
206     let result: any;
207     try {
208       result = this.resultSelector.apply(this, args);
209     } catch (err) {
210       this.destination.error(err);
211       return;
212     }
213     this.destination.next(result);
214   }
215 }
216
217 interface LookAheadIterator<T> extends Iterator<T> {
218   hasValue(): boolean;
219   hasCompleted(): boolean;
220 }
221
222 class StaticIterator<T> implements LookAheadIterator<T> {
223   private nextResult: IteratorResult<T>;
224
225   constructor(private iterator: Iterator<T>) {
226     this.nextResult = iterator.next();
227   }
228
229   hasValue() {
230     return true;
231   }
232
233   next(): IteratorResult<T> {
234     const result = this.nextResult;
235     this.nextResult = this.iterator.next();
236     return result;
237   }
238
239   hasCompleted() {
240     const nextResult = this.nextResult;
241     return nextResult && nextResult.done;
242   }
243 }
244
245 class StaticArrayIterator<T> implements LookAheadIterator<T> {
246   private index = 0;
247   private length = 0;
248
249   constructor(private array: T[]) {
250     this.length = array.length;
251   }
252
253   [Symbol_iterator]() {
254     return this;
255   }
256
257   next(value?: any): IteratorResult<T> {
258     const i = this.index++;
259     const array = this.array;
260     return i < this.length ? { value: array[i], done: false } : { value: null, done: true };
261   }
262
263   hasValue() {
264     return this.array.length > this.index;
265   }
266
267   hasCompleted() {
268     return this.array.length === this.index;
269   }
270 }
271
272 /**
273  * We need this JSDoc comment for affecting ESDoc.
274  * @ignore
275  * @extends {Ignored}
276  */
277 class ZipBufferIterator<T, R> extends OuterSubscriber<T, R> implements LookAheadIterator<T> {
278   stillUnsubscribed = true;
279   buffer: T[] = [];
280   isComplete = false;
281
282   constructor(destination: PartialObserver<T>,
283               private parent: ZipSubscriber<T, R>,
284               private observable: Observable<T>) {
285     super(destination);
286   }
287
288   [Symbol_iterator]() {
289     return this;
290   }
291
292   // NOTE: there is actually a name collision here with Subscriber.next and Iterator.next
293   //    this is legit because `next()` will never be called by a subscription in this case.
294   next(): IteratorResult<T> {
295     const buffer = this.buffer;
296     if (buffer.length === 0 && this.isComplete) {
297       return { value: null, done: true };
298     } else {
299       return { value: buffer.shift(), done: false };
300     }
301   }
302
303   hasValue() {
304     return this.buffer.length > 0;
305   }
306
307   hasCompleted() {
308     return this.buffer.length === 0 && this.isComplete;
309   }
310
311   notifyComplete() {
312     if (this.buffer.length > 0) {
313       this.isComplete = true;
314       this.parent.notifyInactive();
315     } else {
316       this.destination.complete();
317     }
318   }
319
320   notifyNext(outerValue: T, innerValue: any,
321              outerIndex: number, innerIndex: number,
322              innerSub: InnerSubscriber<T, R>): void {
323     this.buffer.push(innerValue);
324     this.parent.checkIterators();
325   }
326
327   subscribe(value: any, index: number) {
328     return subscribeToResult<any, any>(this, this.observable, this, index);
329   }
330 }