# simple-module-redux

> ## Installation

Latest version **0.3.1** (published 2019-09-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-module-redux
pnpm add simple-module-redux
yarn add simple-module-redux
bun add simple-module-redux
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2019-09-02 |
| First published | 2019-07-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 46.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | qiyunjiang |
| Maintainers | daqi |
| Keywords | redux, middleware, redux-middleware, module |

## Links

- npm: https://www.npmjs.com/package/simple-module-redux
- Repository: https://github.com/daqi/simple-module-redux
- Homepage: https://github.com/daqi/simple-module-redux#readme
- Issues: https://github.com/daqi/simple-module-redux/issues
- npm.io page: https://npm.io/package/simple-module-redux

## Dependencies (1)

- [redux](https://npm.io/package/redux.md) ^4.0.3

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.3.1 (latest) — 2019-09-02
- 0.3.0 — 2019-08-30
- 0.2.0 — 2019-07-16
- 0.1.10-alpha.0 — 2019-07-15
- 0.1.9 — 2019-07-12
- 0.1.8 — 2019-07-12
- 0.1.7 — 2019-07-12
- 0.1.6 — 2019-07-11
- 0.1.4 — 2019-07-11
- 0.1.2 — 2019-07-11
- 0.1.0 — 2019-07-11
- 0.0.14 — 2019-07-11
- 0.0.13 — 2019-07-11
- 0.0.12 — 2019-07-10
- 0.0.7 — 2019-07-10
- … 6 more at https://npm.io/package/simple-module-redux/versions

## README

# simple-module-redux

## Installation

```
npm install simple-module-redux
```

## Module { name, state, reducers, actions }

```javascript
const asyncFn = payload => {
  return new Promise(resolve => {
    setTimeout(() => {
      resolve({ number: 666 + payload });
    }, 2000);
  });
};
const moduleDemo = {
  name: 'demo',
  state: {
    number: 1
  },
  reducers: {
    save(state, payload) {
      return { ...state, ...payload };
    }
  },
  actions: {
    add({ commit, state }, payload) {
      commit({
        type: 'save',
        payload: { number: state.number + payload }
      });
    },
    minus({ commit, state }, payload) {
      commit({
        type: 'save',
        payload: { number: state.number - payload }
      });
    },
    asyncUpdate({ commit, state }, payload) {
      return asyncFn(payload).then(res => {
        commit({
          type: 'save',
          payload: { number: res.number }
        });
        return res;
      });
    }
  }
};
```

## Modules

```javascript
const modules = {
  [demoModule.name]: demoModule,
  [otherModule.name]: otherModule
  // ...
};
```

## Usage

### use smrCreateStore

```javascript
import { smrCreateStore } from 'simple-module-redux';
import reduxLogger from 'redux-logger';
const store = smrCreateStore(
  modules,
  preloadedState,
  applyMiddleware(reduxLogger)
);
store.dispatch({
  type: 'demo/add',
  payload: 5
});
store.dispatch({
  type: 'demo/minus',
  payload: 3
});
store.dispatch({
  type: 'demo/asyncUpdate',
  payload: 666
});
```

### use smrEnhancer

```javascript
import { createStore, compose } from 'redux';
import { smrEnhancer } from 'simple-module-redux';
import reduxLogger from 'redux-logger';
import modules from './modules';
const store = createStore(
  modules,
  preloadedState,
  compose(
    smrEnhancer,
    applyMiddleware(reduxLogger)
  )
);
```

### use smrMiddleware & generateReducer

```javascript
import { createStore, applyMiddleware } from 'redux';
import { smrMiddleware, generateReducer } from 'simple-module-redux';
import reduxLogger from 'redux-logger';
import modules from './modules';
const reducer = generateReducer(modules);
const store = createStore(
  reducer,
  preloadedState,
  applyMiddleware(smrMiddleware, reduxLogger)
);
```

## plugins

We has most popular plugin, `smr-plugin-immer`, `smr-plugin-loading`.

### use smrCreateStoreWithPlugin

```javascript
import { smrCreateStoreWithPlugin } from 'simple-module-redux';
import withImmer from 'smr-plugin-immer';
import withLoading from 'smr-plugin-loading';
import reduxLogger from 'redux-logger';
const smrCreateStore = smrCreateStoreWithPlugin([withImmer(), withLoading()]);
const store = smrCreateStore(
  modules,
  preloadedState,
  applyMiddleware(reduxLogger)
);
```

### use smrEnhancerWithPlugin

```javascript
import { createStore, compose } from 'redux';
import { smrEnhancerWithPlugin } from 'simple-module-redux';
import withImmer from 'smr-plugin-immer';
import withLoading from 'smr-plugin-loading';
import reduxLogger from 'redux-logger';
import modules from './modules';
const smrEnhancer = smrEnhancerWithPlugin([withImmer(), withLoading()]);
const store = createStore(
  modules,
  preloadedState,
  compose(
    smrEnhancer,
    applyMiddleware(reduxLogger)
  )
);
```

### use smrMiddleware & generateReducer

```javascript
import { createStore, applyMiddleware } from 'redux';
import { smrMiddleware, generateReducer } from 'simple-module-redux';
import withImmer from 'smr-plugin-immer';
import withLoading from 'smr-plugin-loading';
import reduxLogger from 'redux-logger';
import modules from './modules';
const reducer = generateReducer(modules, [withImmer(), withLoading()]);
const store = createStore(
  reducer,
  preloadedState,
  applyMiddleware(smrMiddleware, reduxLogger)
);
```

---
_Source: https://npm.io/package/simple-module-redux · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._