RoyalIcing / redux-ignore

:recycle: higher-order reducer to ignore redux actions

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

redux-ignore

NPM version (>=1.1) Build Status Dependencies js-standard-style https://gratipay.com/omnidan/

higher-order reducer to ignore redux actions

Installation

npm install --save redux-ignore

API

import ignoreActions from 'redux-ignore';
ignoreActions(reducer, [ARRAY_OF_ACTIONS])
ignoreActions(reducer, (action) => !action.valid)

Ignoring actions

redux-ignore is a reducer enhancer (higher-order reducer), it provides the ignoreActions function, which takes an existing reducer and either:

  • An array of actions to be ignored, or...
  • A predicate function for filtering out actions.

Firstly, import redux-ignore:

// Redux utility functions
import { combineReducers } from 'redux';
// redux-ignore higher-order reducer
import ignoreActions from 'redux-ignore';

Then, add ignoreActions to your reducer(s) like this:

combineReducers({
  counter: ignoreActions(counter, [INCREMENT_COUNTER])
});

Now you won't be able to increment the counter anymore, because the INCREMENT_COUNTER action is ignored.

Alternatively, you can ignore actions via a predicate function:

combineReducers({
  counter: ignoreActions(counter, (action) => action.type === INCREMENT_COUNTER)
});

What is this magic? How does it work?

Have a read of the Implementing Undo History recipe in the Redux documents, which explains in detail how higher-order reducers work.

License

MIT, see LICENSE.md for more information.

About

:recycle: higher-order reducer to ignore redux actions

License:MIT License


Languages

Language:JavaScript 100.0%