redux-load-error

1.0.3 • Public • Published

redux-load-error NPM version Build Status Dependency Status Coverage percentage

Pre-reducer for UI reducers that can be loading or have an error

Installation

$ npm install --save redux-load-error

Usage

Compose your reducer with this pre-reducer to have it handle the loading and error properties for the UI component you are referencing. You need to declare which actions will cause the component to load, display an error, or display its default content.

import * as actions from 'actions';
import loadAndError from 'react-load-error';
 
const loadingActions = [actions.LOADING];
const notLoadingActions = [actions.DONE];
const errorActions = [actions.ERROR];
 
const reducer = (state = { foo: 'foo' }, action) => {
  switch (action.type) {
    case actions.FOO:
      return { ...state, foo: action.foo };
    default:
      return state;
  }
}
 
export default loadAndError(reducer, loadingActions, notLoadingActions, errorActions);

Now the pre-reducer will handle the loading and error properties for you.

import { createStore } from 'redux';
import * as actions from 'actions';
import reducer from 'reducer';
 
let store = createStore(reducer);
 
store.dispatch({ type: actions.LOADING }); 
// loading: true, error: undefined
 
store.dispatch({ type: actions.DONE });
// loading: false, error: undefined
 
store.dispatch({ type: actions.ERROR, error: 'An error' });
// loading: false, error: 'An error'

Reference

loadAndError(reducer, loadingActions, notLoadingActions, errorActions, [options])

reducer

The base reducer to compose

loadingActions

An array of action types that will set loading to true and error to undefined

notLoadingActions

An array of action types that will set loading to false and error to undefined

errorActions

An array of action types that will set loading to false and error to action.error

options

An object containing one, all or none of the following options:

loadingProp

A string that denotes the property key to use for loading, defaults to loading

errorProp

A string that denotes the property key to use for error, defaults to error

keepErrors

If set to true nothing will set the error property to undefined, you can do it in your base reducer. Defaults to false.

Related

License

MIT © Marco Scabbiolo

Dependents (0)

Package Sidebar

Install

npm i redux-load-error

Weekly Downloads

4

Version

1.0.3

License

MIT

Unpacked Size

11.8 kB

Total Files

5

Last publish

Collaborators

  • marcoscabbiolo