| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849 |
- import { ObservableInputTuple, OperatorFunction } from '../types';
- import { merge } from './merge';
- /**
- * Merge the values from all observables to a single observable result.
- *
- * Creates an observable, that when subscribed to, subscribes to the source
- * observable, and all other sources provided as arguments. All values from
- * every source are emitted from the resulting subscription.
- *
- * When all sources complete, the resulting observable will complete.
- *
- * When any source errors, the resulting observable will error.
- *
- * ## Example
- *
- * Joining all outputs from multiple user input event streams
- *
- * ```ts
- * import { fromEvent, map, mergeWith } from 'rxjs';
- *
- * const clicks$ = fromEvent(document, 'click').pipe(map(() => 'click'));
- * const mousemoves$ = fromEvent(document, 'mousemove').pipe(map(() => 'mousemove'));
- * const dblclicks$ = fromEvent(document, 'dblclick').pipe(map(() => 'dblclick'));
- *
- * mousemoves$
- * .pipe(mergeWith(clicks$, dblclicks$))
- * .subscribe(x => console.log(x));
- *
- * // result (assuming user interactions)
- * // 'mousemove'
- * // 'mousemove'
- * // 'mousemove'
- * // 'click'
- * // 'click'
- * // 'dblclick'
- * ```
- *
- * @see {@link merge}
- *
- * @param otherSources the sources to combine the current source with.
- * @return A function that returns an Observable that merges the values from
- * all given Observables.
- */
- export function mergeWith<T, A extends readonly unknown[]>(
- ...otherSources: [...ObservableInputTuple<A>]
- ): OperatorFunction<T, T | A[number]> {
- return merge(...otherSources);
- }
|
