persist-redux-slice
v1.1.8
Published
Automatically persist a redux slice in localStorage.
Downloads
29
Maintainers
Readme
Persist Redux Slice
Automatically persist a redux slice in localStorage.
// store.js
import { configureStore } from "@reduxjs/toolkit";
import {
persist,
persistenceMiddleware,
LoadSlicesFromLocalStorage
} from "persist-redux-slice";
import counterReducer from "./slices/counter.js";
export const store = configureStore({
reducer: {
counter: persist({ counter: counterReducer }),
},
middleware: (getDefaultMiddleware) => {
return getDefaultMiddleware().concat(persistenceMiddleware);
},
});
store.dispatch(LoadSlicesFromLocalStorage);
// slices/counter.js
const slice = createSlice({
name: "counter",
initialState: { },
reducers: { },
});
export default slice.reducer;
Options
persist
can take a second options
object.
msDebounce
: Slices are written to localStorage after a period of inactivity, to prevent rapid subsequent writes. Defaults to 250ms.storageKey
: A unique key in localStorage. Defaults to the name of the slice concatenated with a hash.
persist(
{ counter: counterReducer },
{ msDebounce: 1500, storageKey: "my-unique-key" }
);
Reducer Name
In persist
's first object, the key should be a slice's name, and the value is its reducer.
For example, consider a slice named "counter":
// slices/counterSlice.js
const counterSlice = createSlice({
name: "counter", // <--------- slice name is "counter"
initialState: {},
reducers: {},
});
export default counterSlice.reducer;
It's easiest to import a reducer by its name:
// store.js
import counter from "./slices/counterSlice.js";
// ↑
// (same as slice name)
export const store = configureStore({
reducer: {
counter: persist({ counter }),
},
// ...
});
Alternatively you can import a reducer by a different name:
// store.js
import counterReducer from "./slices/counterSlice.js";
export const store = configureStore({
reducer: {
// specify slice name ↓
counter: persist({ counter: counterReducer }),
},
// ...
});