9

Can someone explain to me why the .flatMap operator can accept a function which returns an Observable, or an array?

The official docs say:

The FlatMap operator transforms an Observable by applying a function that you specify to each item emitted by the source Observable, where that function returns an Observable that itself emits items.

Why can it also return an array?

For example, these are both valid:

obs$.flatMap((data) => {
    return [];
});

obs$.flatMap((data) => {
    return new Observable<string>();
});

But this does not work:

obs$.flatMap((data) => {
    return 1;
});
Dolan
  • 1,519
  • 4
  • 16
  • 36
  • 4
    Observables can be thought of as arrays spread over time, so flattening an array is like flattening a synchronous observable. `1` is neither an array nor an observable, so of course it doesn't work. – cartant Jul 23 '17 at 00:18
  • `flatMap` is an alias for `mergeMap`. Check the docs and you will see the function can return an observable, a promise, or an array-like value: http://reactivex.io/rxjs/class/es6/Observable.js~Observable.html#instance-method-mergeMap – cartant Jul 23 '17 at 00:22
  • 1
    Specifically, it can return an `ObservableInput`: http://reactivex.io/rxjs/class/es6/MiscJSDoc.js~ObservableInputDoc.html – cartant Jul 23 '17 at 00:24
  • Thanks, that helped my understanding of it a lot, did not realise it was `ObservableInput`. So how can `.flatMap` return an array of Observables? Or is that not possible? – Dolan Jul 23 '17 at 00:32
  • 1
    If you call `flatMap` on an array of observables, you'll get an observable of observables - termed a higher-order observable. There are operators to further flatten such higher-order observables. Look at [`mergeAll`](http://reactivex.io/rxjs/class/es6/Observable.js~Observable.html#instance-method-mergeAll) and [`concatAll`](http://reactivex.io/rxjs/class/es6/Observable.js~Observable.html#instance-method-concatAll). Also, if the links have helped you understand things, you might want to consider adding a [self answer](https://stackoverflow.com/help/self-answer). – cartant Jul 23 '17 at 00:55

1 Answers1

7

The official docs are not relevant because they refer to RxJS 4 and not RxJS 5.

mergeMap projection function returns not just Observable but ObservableInput interface, which applies to miscellaneous values that can be converted to observables:

Arrays can be interpreted as observables that emit all values in array one by one, from left to right, and then complete immediately.

This means that 

obs$.flatMap((data) => arr)

is basically a shorter version of

obs$.flatMap((data) => Observable.from(arr))
Estus Flask
  • 206,104
  • 70
  • 425
  • 565