redux-storage.redux.txt

                 
   REDUX-STORAGE  
                 


VERSION ==>                       #1.4.1
                                  #[De]serialize Redux STATE (e.g. on localStorage)


                                             /=+===============================+=\
                                            /  :                               :  \
                                            )==:             BASE              :==(
                                            \  :_______________________________:  /
                                             \=+===============================+=/


RSTORAGE.createMiddleware
(ENGINE[, VAL_ARR][, VAL2_ARR])   #Does ENGINE.save(STATE) after each ACTION.
->REDUX_MDWR                      #VAL_ARR are blacklisted ACTION.type, VAL2_ARR whitelisted.
SAVE_ACTION                       #ACTION:
                                  #  - type RSTORAGE.SAVE
                                  #  - payload STATE
                                  #Dispatched after ENGINE.save(STATE) but does not do anything by itself.


RSTORAGE.createLoader(ENGINE)     #FUNC(STORE) does:
->FUNC(STORE)                     #  - ENGINE.load(STATE)
                                  #  - dispatch LOAD_ACTION with STATE2
                                  #  - returns its PROMISE
LOAD_ACTION                       #ACTION:
                                  #  - type RSTORAGE.LOAD
                                  #  - payload STATE2
RSTORAGE.reducer                  #RFUNC which merges LOAD_ACTION.payload into STATE


                                             /=+===============================+=\
                                            /  :                               :  \
                                            )==:            ENGINES            :==(
                                            \  :_______________________________:  /
                                             \=+===============================+=/


ENGINE                            #Base class for what serializes STATE
ENGINE.load(STATE)->PROMISE       #PROMISE must resolve with STATE2
ENGINE.save(STATE)->PROMISE       #PROMISE must resolve with nothing

RLOCALSTORAGE('KEY')              #ENGINE that uses localStorage.getItem|setItem('KEY') and JSON.stringify|parse(STATE)
RLOCALSTORAGEFAKEPROMISE('KEY')   #Same for environments without ES6 promises
RREACTIVENATIVEASYNC('KEY')       #ENGINE that uses React-Native AsyncStorage instead of localStorage


                                             /=+===============================+=\
                                            /  :                               :  \
                                            )==:          DECORATORS           :==(
                                            \  :_______________________________:  /
                                             \=+===============================+=/


RSTORAGE.debounce
(ENGINE, NUM)->ENGINE             #Make ENGINE.save() debounce with NUM ms
RSTORAGE.filter
(ENGINE, 'VAR'[_ARR]_ARR)->ENGINE #Make ENGINE.save() use a deep copy of STATE, with only STATE.VAR. Use VAR_ARR for nested variables.
RSTORAGE.immutablejs
(ENGINE, 'VAR'[_ARR]_ARR)->ENGINE #Same for ENGINE.load(), and make new STATE a IMMUTABLE_MAP