0.1.2 • Published 7 years ago

redux-most-factory v0.1.2

Weekly downloads
4
License
MIT
Repository
github
Last release
7 years ago

redux-most-factory · npm

I am tired of managing actions, actions creators and reducers in Redux. Luckily, I am not alone, so there are many cool libraries simplifying that. I am also tired of managing actions, actions creators and epics in redux-most. Well, I hope I am alone on this one too, but there are no such libraries yet, so here is it. These 20 lines of code cut half of my files with epics, and make me much happier as a result.

Table of Contents

Install

yarn add redux-most-factory
  # or
npm install --save redux-most-factory

Usage

First setup the redux-most, see its documentation on how to do that.

Then instead of doing this:

import {map} from 'most';
import {select, combineEpics} from 'redux-most';

/* Actions */

const INCREMENT = '@epic/INCREMENT';
const DECREMENT = '@epic/DECREMENT';

/* Epics */

const incrementEpic = (action$) => {
    const increment$ = select(INCREMENT, action$);
    return map(() => ({type: 'INCREMENT'}), increment$);
}

const decrementEpic = (action$) => {
    const decrement$ = select(DECREMENT, action$);
    return map(() => ({type: 'DECREMENT'}), decrement$);
}

/* Action Creators */

export const increment = () => ({
    type: INCREMENT,
});

export const decrement = () => ({
    type: DECREMENT,
});

export default combineEpics([incrementEpic, decrementEpic]);

You can do this:

import {map} from 'most';
import epicFactory from 'redux-most-factory';

const epics = {
    increment: action$ => map(() => ({type: 'INCREMENT'}), action$),
    decrement: action$ => map(() => ({type: 'DECREMENT'}), action$),
};

export default epicFactory(epics, '@epic/');
/*
 * {
 *     epic, // the result of combineEpics
 *     increment,
 *     decrement,
 * }
 */

Examples

A very plain example with redux-most and redux-most-factory. It's for testing purposes mostly.

API

epicFactory(epics, prefix)

Arguments

  1. epics (Object): An object of functions. Each property key will be used as both an action type prefixed with a prefix, and a name of an action creator function. An action creator takes three arguments payload, error (defaults to false) and meta (defaults to null) and returns a dispatchable object (action).
  2. prefix (String): It will be used to prefix all actions from the epics.