Notoriously Punctual Manatee

    xstream-connect

    0.2.3 • Public • Published

    xstream-connect

    higher order component to plug xstream as a store with React components

    Build Status

    Install

    yarn add xstream-connect
    

    Disclaimer

    This package feets well the way we work and the problems we faces (small size stores but complex async workflow on derived data). It's mostly intended to our own developments and is not well tested.

    The purpose here is not to provide an async middleware to a redux store with Streams, as redux-cycle-middleware and redux-observable do but to replace redux and its different slices (async middlewares, reducers and derived data) with (Memory)Streams. As this, we can express each variable of the store as a function of other variables, in a clean and async way.

    xstream's Streams are the perfect tool to achieve this goal, as they are hot and can easily be transformed into MemoryStreams (via the remember method).

    This library only exposes a component Provider and an higher order function connect to connect your store to the React layer in a react-redux fashion.

    Basic example

    import React from 'react';
    import ReactDOM from 'react-dom';
    import xs from 'xstream';
    import {connect, Provider} from 'xstream-connect';
     
    const store = {
      count$: xs.periodic(1000).startWith(0),
      hello$: xs.of('hello')
    };
     
    class App extends React.Component { 
      render(){
        return <div>{this.props.count} --- {this.props.hello}</div>;
      }
    }
     
    const Connected = connect(
      state => ({
        count: state.count$,
        hello: state.hello$
      })
    )(App);
     
    ReactDOM.render(
      <Provider store={store}>
        <Connected />
      </Provider>,
      document.querySelector('#root')
    );

    Principles

    Store and the Provider component

    With this architecture, all the logic resides in Streams, the store props of the Provide component is just a hash/dictionary of Streams you want to expose to the React layer.

    // main.js
    import React from 'react';
    import ReactDOM from 'react-dom';
    import {Provider} from 'xstream-connect';
    import * as store from './store'; // <---- your store is just a dictionnary of exposed Streams
     
    ReactDOM.render(
      <Provider store={store}> {/* <-- plugged your store to the React layer */}
        <Connected />
      </Provider>,
      document.querySelector('#root')
    );
     

    The connect function

    The connect function is far more basic than its react-redux counterpart, currently it just takes a mapStateToProps function as parameter. It will listen to all Streams provided in the mapStateToProps and deliver their values into the props with the right key.

    // components/MyComp.js
    import React from 'react';
    import {connect} from 'xstream-connect'; 
     
    class MyComp extends React.Component {   
      render(){
        return <div>{this.props.counter}</div>
      }
    }
     
    export default connect(
      // mapStateToProps parameter
      // in  this example, we map the value of the Stream *counter$* in a *counter* props 
      state => ({   
        counter: state.counter$  
      })
    )(MyComp);
     

    How to dispatch actions from the React layer to the store ?

    There is no canonical way to achieve this. For instance, you can do as this:

    • in your store, expose a dispatcher$ Stream of Stream, as this the React layer could have a Subject to inject actions
    • in your store, create an actions$ Stream that flatten dispatcher$
    // store index.js
    import _ from 'lodash/fp';
    import xs from 'xstream';
     
    export const dispatcher$ = xs.of(xs.create()).remember();
    const actions$ = dispatcher$.flatten().remember();
     
    // little helper
    // to check if an action is of a certain type
    const isType = type => _.flow(_.get('type'), _.isEqual(type));
     
    // an exposed Stream that depends on an action
    export const counter$ = actions$
      .filter(isType('increment'))
      .fold(acc => acc + 1, 0)
      .startWith(0)
      .remember();
    • expose your store into the React layer context
    // main.js
    import {Provider} from 'xstream-connect';
    import * as store from './store'; // dispatcher$ is exposed 
     
    // ...
    • via the connect method to actionsProvider$, retrieve an Stream into your component's props:
    // components/MyComponent.js
    import {connect} from 'xstream-connect';
     
    class MyComponent extends React.Component {
      
      handleClick = () => this.props.dispatcher.shamefullySendNext({type: 'increment'})
      
      render(){
        return <div onClick={this.handleClick}>{this.props.counter}</div>;
      }
    }
     
    export default connect(
      state => ({
        // The trick is here
        // the value of state.actionsProvider$ is an Stream that can trigger side effects
        dispatcher: state.dispatcher$,
        counter: state.counter$,
      })
    )(MyComponent);
    // ...

    Why don't you use cycle.js?

    cycle.js is neat, but we kinda like the React/redux architecture and the React ecosystem... and are also tired of the growing complexity of the redux layer when you want to manage asynchronicity.

    License

    MIT License

    Copyright (c) 2017 serac.io

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Keywords

    Install

    npm i xstream-connect

    DownloadsWeekly Downloads

    1

    Version

    0.2.3

    License

    MIT

    Last publish

    Collaborators

    • seracio