redux-effects-localstorage

Redux effects driver for localStorage

Installation

$ npm install redux-effects-localstorage

Usage

Simple redux-effects driver for localStorage. Add it to your redux middleware stack like this:

import localStorage from 'redux-effects-localstorage'

applyMiddleware(localStorage(window.localStorage))(store)

And then dispatch it actions, like this:

store.dispatch({
  type: 'EFFECT_LOCALSTORAGE',
  payload: {
    type: 'setItem',
    key: 'todos.0',
    value: 'Clean the kitchen'
  }
})

Or, use the action creators that come bundled with it:

import localStorage from 'redux-effects-localStorage'

store.dispatch(localStorage.setItem('todos.0', 'Clean the kitchen'))

The API of the action creators is identical to that of the native localStorage object, with the sole exception that the property length has been changed to the function getLength.

Example - Auth token getter/setter

Getting/setting an auth token:

function authToken (newToken) {
  return arguments.length > 0 
    ? localStorage.setItem('authToken', newToken)
    : localStorage.getItem('authToken')
}

function setUserToken (token) {
  return {type: 'SET_USER_TOKEN', payload: token}
}

function reducer (state, action) {
  if (action.type === 'SET_USER_TOKEN') {
    return {
      ...state,
      authToken: action.payload
    }
  }
}

function checkUserStatus () {
  store
   .dispatch(authToken())
   .then(token => store.dispatch(setUserToken(token))
}

Use with sessionStorage

Each of the action creators takes another parameter, STORAGE_TYPE. You can access this from STORAGE_TYPE exported by this module. Values are local (the default) and session, which you can use if you want the actions to be applied to session storage rather than local storage.

License

The MIT License

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.