feature-redux-persist

2.1.1 • Public • Published

feature-redux-persist

feature-redux-persist is a feature-u integration point to redux-persist. It promotes the persistedReducerAspect (a feature-u plugin) that facilitates redux-persist integration to your features.

feature-redux-persist relies on feature-redux to provide redux integration.

You have to be aware of feature-u philosophy and know about is implementation before reading this documentation

Build Status Codacy Badge Codacy Badge NPM Version Badge

Install

peerDependencies, you should already have these, because this is our integration point (but just in case):

yarn add feature-u
yarn add react
yarn add redux
yarn add react-redux
yarn add feature-redux

the main event:

yarn add feature-redux-persist

Usage

Register

Within your mainline, register the feature-redux reducerAspect (see **1** below) and the feature-redux-persist reducerPersistedAspect (see **2**) to feature-u's launchApp()

Note **3** : persistedReducerAspect has a required storage configuration parameter (see below)

Note **4** : ORDER MATTER, you have to declare persistedReducerAspect before reducerAspect !

src/app.js

import {launchApp}                    from 'feature-u';
import {createReducerAspect}          from 'feature-redux'; // **1**
import {createPersistedReducerAspect} from 'feature-redux-persist'; // **2**
import AsyncStorage                   from '@react-native-community/async-storage'; // for react-native
import features                       from './feature';
 
export default launchApp({
 
  const persistedReducerAspect = createPersistedReducerAspect(AsyncStorage); // **2**  **3**
  aspects: [
    persistedReducerAspect,                        // **4**
    createReducerAspect(),                         // **1**
    ... other Aspects here
  ],
 
  features,
 
  registerRootAppElm(rootAppElm) {
    ReactDOM.render(rootAppElm,
                    getElementById('myAppRoot'));
  }
});

Syntax

+ createPersistedReducerAspect(storage): Aspect

Parameters

storage

This configuration parameter is required.

You can use every storage in that list: https://github.com/rt2zz/redux-persist#storage-engines

return value

An feature-u Aspect

Promote reducers

/!\ Before reading, you might take a look to https://github.com/KevinAst/feature-redux#usage.

In the state.js, there is some classic redux reducer.

**5** : Enhance basic reducer with persistReducer decorator from redux-persist module.

**6** : Wrap to all thing with slicedReducer from feature-redux module.

Note that you still can use non-persisted reducers with this aspect, you just have to bypass **5**.

import { createFeature } from 'feature-u';
import { slicedReducer } from 'feature-redux';
import { persistReducer } from 'redux-persist';
import AsyncStorage from '@react-native-community/async-storage';
 
import fname from './feature-name';
import reducer, from './state';
 
export default createFeature({
  name: fname,
  enabled: true,
 
  reducer: slicedReducer( // **6**
    fname,
    persistReducer({ key: fname, storage: AsyncStorage }, reducer) // **5**
  ),
 
  // ... snip snip (other aspect properties here)
});

Readme

Keywords

none

Package Sidebar

Install

npm i feature-redux-persist

Weekly Downloads

0

Version

2.1.1

License

MIT

Unpacked Size

15.9 kB

Total Files

14

Last publish

Collaborators

  • sylvainlg