rxjs-multiscan-operator v1.1.0

Observable.multiScan

Custom RxJS 5 operator for sharing state between Observables in safe and controlled manner. It is an extension of scan operator for multiple Observables.

Motivation

Say you are displaying two buttons and a counter (starting with zero) on a web page. When user clicks first button, the counter should be increased by one. When second button is clicked, counter should be decreased.

Usual solution is to merge two Observables, somehow mark values from each and then use scan detecting with switch statement if we should increase or decrease counter. This results in Redux-like code:

const allClicks = Observable.merge(
    clicksFromFirst.mapTo({type: 'INCREASE'}), 
    clicksFromSecond.mapTo({type: 'DECREASE'})
);

const counterValues = allClicks.scan((counter, click) => {
    switch (click.type) {
        case 'INCREASE':
            return counter + 1;
        case 'DECRASE':
            return counter - 1;
        default:
            throw Error(`Unknown click type: ${click.type}`)
    }
}, 0);

Redux is cool architecture, but this is a bit much to simply share some stateful computation between Observables. There is quite a lot of boilerplate. Default case is handled awkwardly and we even know that it will never happen, but the linter will still complain. Also TypeScript handles such code poorly, since it is difficult for compiler (without additional help and thus more boilerplate) to guess what values will appear in reducer function.

With multiScan the same functionality can be implemented like so:

const counterValues = Observable.multiScan(
    [clicksFromFirst, (counter, click) => counter + 1],
    [clicksFromSecond, (counter, click) => counter - 1],
    0
);

We are passing arrays, which have two elements each: Observable with some values and a reducer function. We also pass initial value, just as in regular scan.

Whenever any of passed Observables emits a value, corresponding reducer will be used to update state. When the other Observable emits, its reducer will be called with the previously updated state.

Now Observables share state in safe and predictable manner.

Usage

Since multiScan operator is not a Observable method, but static function, you can simply import and use it directly:

import { multiScan } from 'rxjs-multiscan-operator';

If you want your multiScan always close, there is an option to patch Observable object as well. Just don't blame me for any name conflicts!

import 'rxjs-multiscan-operator/add';