river-store

Caipi river store

Scalable, reduce-able & 'state' based store for (but not limited to) ReactJS

What else ?

• ES6/7 class
• Inherit node EventEmitter api

Example store

import rStore from "river-store";

export default class MyStore extends rStore {
    static follow   = ["someKey"];// keys for the default shouldPropag fn
    
    /**
     * Overridable method to know if a state change should be propag to the listening stores & components
     * If static follow is defined, super.shouldPropag will return true if any of the "follow" keys was updated 
     * If not it will always return true
     * @param newState
     */
    shouldPropag( newState )

    /**
     * Overridable reducer / remapper (will call the constructor's reducer fn if there)
     * If privateState or lastPublicState are simple hash maps super.reduce will return {...lastPublicState, ...privateState}
     * if not it will return the last private state
     * @param privateState 
     * @param lastPublicState
     * @returns {new_public_state}
     */
    reduce( privateState, lastPublicState ) 
}

Prototype

export default class Store extends EventEmitter {

    static named  = {};
    static minFps = 0;

    /**
     * Map all nammed stores in {keys} to the {object}'s state
     * Hook componentWillUnmount (for react comp) or destroy to unBind them automatically
     * @static
     * @param object {React.Component|Store|...} target state aware object
     * @param keys {Array} Ex : ["session", "otherStaticNamedStore:key", store.as('anotherKey')]
     */
    static map( component, keys, context ) 
    
    /**
     * Constructor, will build a torrent store/reducer
     *
     * (context, keys, name)
     * (context, name)
     * (context)
     *
     * @param context {object} context where to find the other stores
     * @param keys {Array} (passed to Store::map) Ex : ["session", "otherNamedStore:key", otherStore.as("otherKey")]
     */
    constructor() 

    /**
     * get a store-key pair for Store::map
     * @param {string} name
     * @returns {{store: Store, name: *}}
     */
    as( name ) 

    /**
     * Un bind this store off the given component-key
     * @param obj
     * @param key
     * @returns {Array.<*>}
     */
    unBind( obj, key ) 

    /**
     * Bind this store changes to the given component-key
     * @param obj {React.Component|Store|function)
     * @param key {string} optional key where to map the public state
     */
    bind( obj, key ) 

    /**
     * Overridable method to know if a state change should be propag to the listening stores & components
     * If static follow is defined, shouldPropag will return true if any of the "follow" keys was updated 
     * If not it will always return true
     */
    shouldPropag( ns )

    /**
     * Overridable reducer / remapper 
     * If privateState or lastPublicState are simple hash maps reduce will return {...lastPublicState, ...privateState}
     * if not it will return the last private state
     * @param privateState
     * @param lastPublicState
     * @returns {*}
     */
    reduce( privateState, lastPublicState ) 

    /**
     * Debounce this store propagation ( & reducing )
     * @param cb
     */
    stabilize( cb ) 



    /**
     * Pull stores in the private state
     * @param stores  {Array} (passed to Store::map) Ex : ["session", "otherNamedStore:key", otherStore.as("otherKey")]
     */
    pull( stores ) 

    /**
     * Apply reduce/remap on the private state & push the resulting "public" state to followers
     * @param cb
     */
    push( state, cb ) 
    
    /**
     * Update the current private state & push it once the store is stable
     * @param pState
     * @param cb
     */
    setState( pState, cb ) 

    /**
     * Replace the current private state & push it once the store is stable
     * @param pState
     * @param cb
     */
    replaceState( pState, cb ) 

    destroy() 
}