npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

redux-effects-steps

v1.0.3

Published

Multiple steps version of redux-effects

Downloads

581

Readme

redux-effects-steps

Another version of redux-effects handling error action properly.

Installation

npm install --save redux-effects-steps

Usage

Installing the middleware

import { createStore, applyMiddleware } from 'redux';
import stepsMiddleware from 'redux-effects-steps';
import rootReducer from './reducers';

const store = createStore(
  rootReducer,
  applyMiddleware(
    stepsMiddleware
  )
);

Defining action creators

import { createAction } from 'redux-actions';
import { steps } from 'redux-effects-steps';
import { fetchrRead } from 'redux-effects-fetchr';

const fetchUserRequest = createAction('FETCH_USER_REQUEST');
const fetchUserSuccess = createAction('FETCH_USER_SUCCESS');
const fetchUserFail = createAction('FETCH_USER_FAIL');

function fetchUser({ user }) {
  return steps(
    fetchUserRequest(),
    fetchrRead('users', { user }),
    [fetchUserSuccess, fetchUserFail]
  );
}

Using actions

const promise = store.dispatch(fetchUser({ user }));

Under the food

Example:

const promise = store.dispatch(steps(
    originAction,
    [firstSuccess, firstFailure],
    [secondSuccess, secondFailure]
  ));

is evaluated by redux-effects-steps like this:

const promise = store.dispatch(originAction)
    .then((result) => store.dispatch(firstSuccess(result)), (error) => store.dispatch(firstFailure(error)))
    .then((result) => store.dispatch(secondSuccess(result)), (error) => store.dispatch(secondFailure(error)));

Kind of Actions

Async Actions

Async action returns a Promise object when it's dispatched. If the dispatched action fails, the returned Promise will be rejected.

Sync Actions

Sync action returns an object which is not a Promise (by default, dispatched action itself.) when it's dispatched. If the action represents fail, it should be error action.

Defferences from redux-effects

Error handling

redux-effects:

import { createAction } from 'redux-actions';
import { bind } from 'redux-effects';
import { fetch } from 'redux-effects-fetch';

const success = createAction('FIND_USER_SUCCESS');
const failure = createAction('FIND_USER_FAILURE');

function findUser(condition) {
  return bind(fetch('/api/users', {method: 'POST', body: condition}), success, failure);
}

const finalPromise = store.dispatch(findUser(condition));

If fetch() action fails, the error action created by failure() is dispatched. And then, redux-effects resolves the next Promise, so the finalPromise isn't rejected.

This is the problem when the action creator is used with redux-form.

In this example, onSubmit() handler always succeed if the action fails.

reduxForm({ form: 'myForm', fields: [...] }, null, {
  onSubmit:(values, dispatch) => dispatch(findUser(values.user))
})(MyForm)

On the other hand, redux-effects-steps rejects the next Promise when error action is dispatched.

Action creator

redux-effects provides an action creator takes just one step.

import { bind } from 'redux-effects';

const action = bind(fetch(), success, failure);

redux-effects-steps provides an action creator takes multiple steps.

import { steps } from 'redux-effects-steps';

const action = steps(begin(),
  [fetch('/api/users')],
  [success, failure]
);

API

Action Creators

steps(origin, [...steps])

Arguments
  • origin (Array|Object)
    • One of the:
      • action (Object): A FSA compliant action object.
      • actions (Array): An array of actions.
  • steps (Array)
    • Each element is in a [success, failure] tuple Array.
    • success and failure are one of the:
      • action (Object): A FSA compliant action object.
      • actions (Array): An array of FSA compliant action object.
      • actionCreator (Function): An action creator.
    • If failure is not needed, you can pass just success instead of an Array.
Returns

(Object): A FSA compliant action object.