redux-simple-storage-middleware
Simple redux
middleware which will store the current state tree in either session- or localstorage. This helps creating an awesome developer experience when combined with hot reloading.
Installation
npm i -S redux-simple-storage-middleware
How to use?
Use middleware
The middleware can be dropped into the redux
middleware chain and will store the complete redux state in either local- or sessionstorage.
; ; const sessionStorageMiddleware = ; const localStorageMiddleware = ; let store = ;
Get initial state
Only using the middleware to store the state tree is not that usefull. That's why redux-simple-storage-middleware
also supports initialising the state from local- or sessionstorage.
; ; const sessionStorageMiddleware = ; const storageState = ; let store = ;
Reference
storagePossible
This variable stores whether it's possible to use the storage
Type: boolean?
createStorageMiddleware
This middleware for redux will store the application state in storage
Parameters
settings
any An object containing the settings for the middlewaresettings.key
The identifier to be used to store state in storagesettings.type
The type of storage to use either sessionStorage or localStoragesettings.exclude
The reducers to exclude from storing
Returns any The final result when all reducers have run
storageTest
This will test whether the requested type of storage is available or not
Parameters
type
string The type of storage to test
Returns boolean True or false depending on whether the storage is available or not
getStorageState
This will get the application state from storage when available
Parameters
settings
any Object containing all settings for the state retreivalsettings.key
The identifier to be used to retreive state from storagesettings.type
The type of storage to use either sessionStorage or localStoragesettings.defaultReponse
The response to give when no storage can be used or if their is nothing available
Returns any The state last stored in storage