Overview

Very simple function to allow persistence of a reducer's state to local storage. Note that this makes the reducer "impure" since it will have the side effect of persisting its state.

This works only in the browser.

Usage

import {saveState, restoreState} from 'persist-reducer'

const saveConfig = {
    storageKey: 'something unique',
    keysToSave: ['key1', key2']  // optional list of keys to include in saved state
}

const defaultState = restoreState(saveConfig, ...)

const reducer = saveState(saveConfig, function(state, action) {
    // normal reducer stuff
})

It is also possible to save / restore a specific value within an object by passing a property path in "keysToSave":

const saveConfig = {
  storageKey: 'unique value',
  keysToSave: ['myObject.myProperty']
}

With that configuration, myObject.myProperty will be saved but the other properties will not be touched.

This can also be passed as an array: keysToSave: [ ['myObject', 'myProperty.with.some.dots'] ] will save the property at myObject['myProperty.with.some.dots']

Comparison with redux-persist

redux-persist is much more featureful. It also registers at the store level, as opposed to persist-reducer which is applied on a single reducer. This makes persist-reducer less intrusive in the project.