README.md

API 文档

redux-mutation API完全继承redux，然后有新增API和小改动。

[参数]中括号代表可选。

顶层 API

import

import {
  combineReducers,
  applyMiddleware,
  //new and changed api below
  compose,
  createStore,
  configCreateStore,
  applyPlugin,
  SEPARATOR,
} from 'redux-mutation';

umd

const {
  combineReducers,
  applyMiddleware,
  //new and changed api below
  compose,
  createStore,
  configCreateStore,
  applyPlugin,
  SEPARATOR,
} = window.ReduxMutation;

• 有变化和新增的 API

  • createStore(mutations, [preloadedState], [enhancer])
  • configCreateStore([plugins], [options])
  • applyPlugin(...plugins)
  • compose(...functions)
  • SEPARATOR，值等于 /。

• 无变化的 API

  • combineReducers(reducers)
  • applyMiddleware(...middlewares)

• 不采用的 API

  如果要使用，请直接使用 redux 的。

  import { bindActionCreators } from 'redux';

  • bindActionCreators(actionCreators, dispatch)

Store API

const store = createStore(mutations);
//或者 const store = configCreateStore(...args)(mutations)
const {
  dispatch,
  getState,
  subscribe,
  replaceReducer,
  replaceMutations,
} = store;

• 有变化和新增的 API

  • store.replaceMutations(mutations)

• 无变化的 API

  • store.getState()

  • store.dispatch(action)

  • store.subscribe(listener)

  • store.replaceReducer(nextReducer)

    兼容 redux replaceReducer，reducer 模式建议使用 replaceMutations。

其他 API

Center

center(action,centerUtils)

CenterEnhancer

centerEnhancer(originalCenter,centerUtils,currentMutation,actionType)

ReducerEnhancer

reducerEnhancer(originalReducer)