redux-local-storage

Redux middleware for accessing local storage

Installation

Install with npm or yarn:

npm install --save redux-local-storage

Usage

Using redux-local-storage in your application is easy:

# install middleware
import createLocalStorage from 'redux-local-storage'
import thunkMiddleware from 'redux-thunk'
import reducer from './reducer'
 
const localStorageMiddleware = createLocalStorage()
 
const createStoreWithMiddleware = applyMiddleware(
  thunkMiddleware,
  localStorageMiddleware
)(createStore)
 
const store = createStoreWithMiddleware(reducer)
 
# action creator
import { LOCAL_GET, LOCAL_SET, LOCAL_REMOVE } from 'redux-local-storage/action_types'
 
export const getSession = () => ({
  type: LOCAL_GET,
  key: 'session',
  request: GET_SESSION_REQUEST,
  success: GET_SESSION_SUCCESS,
  failure: GET_SESSION_FAILURE
})
 
export const setSession = (session) => ({
  type: LOCAL_SET,
  key: 'session',
  value: session,
  request: SET_SESSION_REQUEST,
  success: SET_SESSION_SUCCESS,
  failure: SET_SESSION_FAILURE
})
 
export const removeSession = () => ({
  type: LOCAL_REMOVE,
  key: 'session',
  request: REMOVE_SESSION_REQUEST,
  success: REMOVE_SESSION_SUCCESS,
  failure: REMOVE_SESSION_FAILURE
})

View example app

Author & Credits

redux-local-storage was originally written by Greg Kops and is based upon his work with Think Topography and The Cornell Cooperative Extension of Tompkins County