zl1437 / redux-promise-middleware

Enables simple, yet robust handling of async action creators in Redux

Redux Promise Middleware

Redux Promise Middleware enables simple, yet robust handling of async action creators in Redux.

const asyncAction = () => ({
  type: 'PROMISE',
  payload: new Promise(...),
})

Given a single action with an async payload, the middleware transforms the action to a separate pending action and a separate fulfilled/rejected action, representing the states of the async action.

The middleware can be combined with Redux Thunk to chain action creators.

const secondAction = (data) => ({
  type: 'SECOND',
  payload: {...},
})

const firstAction = () => {
  return (dispatch) => {
    const response = dispatch({
      type: 'FIRST',
      payload: new Promise(...),
    })

    response.then((data) => {
      dispatch(secondAction(data))
    })
  }
}

Documentation and Help

• Introduction
• Guides
• Examples

Heads Up: Version 6 includes some breaking changes. Check the upgrading guide for help.

Issues

For bug reports and feature requests, file an issue on GitHub.

For help, ask a question on StackOverflow.

Releases

• Release History
• Upgrade from 5.x to 6.0.0
• Upgrade from 4.x to 5.0.0
• Upgrade from 3.x to 4.0.0

For older versions:

• 5.x
• 4.x
• 3.x
• 2.x
• 1.x

Maintainers

Please reach out to us if you have any questions or comments.

Patrick Burtchaell (pburtchaell):

• Twitter
• GitHub

Thomas Hudspith-Tatham (tomatau):

• GitHub

License

Code licensed with the MIT License (MIT).

Documentation licensed with the CC BY-NC License.