sebastianjg/redux-saga-thunk

Dispatching an action handled by redux-saga returns promise

redux-saga-thunk

Dispatching an action handled by redux-saga returns promise. It looks like redux-thunk, but with pure action creators.

class MyComponent extends React.Component {
  componentWillMount() {
    // `doSomething` dispatches an action which is handled by some saga
    this.props.doSomething().then((detail) => {
      console.log('Yaay!', detail)
    }).catch((error) => {
      console.log('Oops!', error)
    })
  }
}

redux-saga-thunk uses Flux Standard Action to determine action's payload, error etc.

Motivation

There are two reasons I created this library: Server Side Rendering and redux-form.

When using redux-saga on server, you will need to know when your actions have been finished so you can send the response to the client. There are several ways to handle that case, and redux-saga-thunk approach is the one I like most. See an example.

With redux-form, you need to return a promise from dispatch inside your submit handler so it will know when the submission is complete. See an example

Finally, that's a nice way to migrate your codebase from redux-thunk to redux-saga, since you will not need to change how you dispatch your actions, they will still return promises.

Install

$ npm install --save redux-saga-thunk

Basic setup

Add middleware to your redux configuration (before redux-saga middleware):

import { createStore, applyMiddleware } from 'redux'
import createSagaMiddleware from 'redux-saga'
import { middleware as thunkMiddleware } from 'redux-saga-thunk'
^

const sagaMiddleware = createSagaMiddleware()
const store = createStore({}, applyMiddleware(thunkMiddleware, sagaMiddleware))
                                              ^

Usage

Add meta.thunk to your actions and receive thunk on response actions:

const resourceCreateRequest = data => ({
  type: 'RESOURCE_CREATE_REQUEST', // you can name it as you want
  payload: data,
  meta: {
    thunk: true
    ^
  }
})

const resourceCreateSuccess = (detail, thunk) => ({
                                       ^
  type: 'RESOURCE_CREATE_SUCCESS', // name really doesn't matter
  payload: detail, // promise will return payload
  meta: {
    thunk
    ^
  }
})

const resourceCreateFailure = (error, thunk) => ({
                                      ^
  type: 'RESOURCE_CREATE_FAILURE',
  error: true, // redux-saga-thunk will use this to determine if that's a failed action
  payload: error,
  meta: {
    thunk
    ^
  }
})

redux-saga-thunk will automatically transform your request action and inject a key into it.

Handle actions with redux-saga like you normally do, but you'll need to grab meta.thunk from the request action and pass it to the response actions:

// thunk will be transformed in something like 'RESOURCE_CREATE_REQUEST_1234567890123456_REQUEST'
// the 16 digits in the middle are necessary to handle multiple thunk actions with same type
function* createResource() {
  while(true) {
    const { payload, meta } = yield take('RESOURCE_CREATE_REQUEST')
                     ^
    try {
      const detail = yield call(callApi, payload)
      yield put(resourceCreateSuccess(detail, meta.thunk))
                                              ^
    } catch (e) {
      yield put(resourceCreateFailure(e, meta.thunk))
                                         ^
    }
  }
}

Dispatch the action from somewhere. Since that's being intercepted by thunkMiddleware cause you set meta.thunk on the action, dispatch will return a promise.

store.dispatch(resourceCreateRequest({ title: 'foo' })).then((detail) => {
  // detail is the action payload property
  console.log('Yaay!', detail)
}).catch((error) => {
  // error is the action payload property
  console.log('Oops!', error)
})

Or use it inside sagas with put.resolve:

function *someSaga() {
  try {
    const detail = yield put.resolve(resourceCreateRequest({ title: 'foo' }))
    console.log('Yaay!', detail)
  } catch (error) {
    console.log('Oops!', error)
  }
}

Usage with selectors

To use isPending and hasFailed selectors, you'll need to add the thunkReducer to your store:

import { combineReducers } from 'redux'
import { reducer as thunkReducer } from 'redux-saga-thunk'

const reducer = combineReducers({
  thunk: thunkReducer,
  // your reducers...
})

Now you can use selectors on your containers:

import { isPending, hasFailed } from 'redux-saga-thunk'

const mapStateToProps = state => ({
  loading: isPending(state, 'RESOURCE_CREATE_REQUEST'),
  error: hasFailed(state, 'RESOURCE_CREATE_REQUEST')
})

API

isPending

Tells if an action is pending

Parameters

• state State
• name (string | Array<string>)

Examples

const mapStateToProps = state => ({
  fooIsPending: isPending(state, 'FOO'),
  fooOrBarIsPending: isPending(state, ['FOO', 'BAR']),
  anythingIsPending: isPending(state)
})

Returns boolean

hasFailed

Tells if an action has failed

Parameters

• state State
• name (string | Array<string>)

Examples

const mapStateToProps = state => ({
  fooHasFailed: hasFailed(state, 'FOO'),
  fooOrBarHasFailed: hasFailed(state, ['FOO', 'BAR']),
  anythingHasFailed: hasFailed(state)
})

Returns boolean

License

MIT © Diego Haz