redux/docs/api

API Reference

The Redux API surface is tiny. Redux defines a set of contracts for you to implement (such as reducers) and provides a few helper functions to tie these contracts together.

This section documents the complete Redux API. Keep in mind that Redux is only concerned with managing the state. In a real app, you’ll also want to use UI bindings like react-redux.

Top-Level Exports

• createStore(reducer, [initialState])
• combineReducers(reducers)
• applyMiddleware(...middlewares)
• bindActionCreators(actionCreators, dispatch)
• compose(...functions)

Store API

• Store
  • getState()
  • dispatch(action)
  • subscribe(listener)
  • getReducer()
  • replaceReducer(nextReducer)

Importing

Every function described above is a top-level export. You can import any of them like this:

ES6

import { createStore } from 'redux';

ES5 (CommonJS)

var createStore = require('redux').createStore;

ES5 (UMD build)

var createStore = Redux.createStore;