redux-saga-api-call v0.0.5

Redux Saga api call (redux-saga-api-call)

Simple api call for Redux Saga

What

Redux Saga api call is a simple method to simplify api calls, instead of calling the api and catch the response and error to dispatch the success and failure action, this call do that for you.

How

import apiCall from 'redux-saga-api-call'

// Api method
const fetchJokeApi = () => fetch('https://api.chucknorris.io/jokes/random')
  .then(response => response.json())
  .then(response => ({response}))
  .catch(error => ({error}))
// -> ATTENTION: It's very important to wrap the response and error in objects called response and error, because the call will destructure the response to identify if the call was successfull or not (If you find a way to improve it, please, make a pull request)

...
// Simplest case
function* fetchJokeWatcher () {
  yield takeEvery('FETCH_JOKE', apiCall(fetchJokeApi))
}
// -> {type: 'FETCH_JOKE_START', payload: <whatever was sent to the action>}
// -> {type: 'FETCH_JOKE_SUCCESS', payload: <server response>}
...

...
// Select data from state and send it to apiMethod
function* fetchJokeWatcher () {
  yield takeEvery(
    'FETCH_JOKE',
    apiCall(
      fetchJokeApi,
      {
        selectFromState: state => state.userPreferences
      }
    )
  )
}
// -> fetchJokeApi({payload: <payload sent to action>, selectedData: <userPreferences>)
...

...
// Transform response and error data
function* fetchJokeWatcher () {
  yield takeEvery(
    'FETCH_JOKE',
    apiCall(
      fetchJokeApi,
      {
        transformResponse: response => response.filter(joke => !joke.includes('Bruce lee')),
        transformError: error => `Error: ${error}`
      }
    )
  )
}
// -> {type: 'FETCH_JOKE_SUCCESS', payload: <All jokes that doesn't include 'Bruce lee' on it>}
// -> {type: 'FETCH_JOKE_FAILURE', payload: 'Error: <the error that the server returned>'}
...

Options

Call the method like this: apiCall(apiMethod, options) apiMethod should be a thenable object

• selectFromState: A function that receives the Redux state, then the apiMethod will receive a merged object between this selectors and the action payload
• transformResponse: Once the apiMethod resolved, the response will be piped through this function and the result will be dispatched as {ACTION_NAME}_SUCCESS (If this is not present, the raw result will be dispatched instead)
• transformError: Once the apiMethod rejected, the error will be piped through this function and the result will be dispatched as {ACTION_NAME}_FAILURE (If this is not present, the raw error will be dispatched instead)

Why

To reduce the boilerplate in most basic api calls

Installation

yarn add redux-saga-api-call
// or
npm install --save redux-saga-api-call

Tests

// jest tests
yarn test
// jest coverage
yarn cover

Contributors

Simply create a pull request :)

• Code style: Standard

Thanks

This project is based on an idea of @pablen about reducing boilerplate in Redux Saga.

License

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.