Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/omnidan/redux-ignore
:recycle: higher-order reducer to ignore redux actions
https://github.com/omnidan/redux-ignore
Last synced: 4 days ago
JSON representation
:recycle: higher-order reducer to ignore redux actions
- Host: GitHub
- URL: https://github.com/omnidan/redux-ignore
- Owner: omnidan
- License: mit
- Created: 2015-10-18T19:14:07.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-02-11T13:29:31.000Z (almost 5 years ago)
- Last Synced: 2024-12-28T08:03:36.318Z (18 days ago)
- Language: JavaScript
- Homepage:
- Size: 32.2 KB
- Stars: 842
- Watchers: 14
- Forks: 29
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-redux - redux-ignore - Higher-order reducer to ignore Redux actions. (Utilities)
README
# redux-ignore
[](https://www.npmjs.com/package/redux-ignore) [](https://travis-ci.org/omnidan/redux-ignore) [](https://david-dm.org/omnidan/redux-ignore) [](http://standardjs.com/) [](https://paypal.me/DanielBugl/10) [](https://gratipay.com/~omnidan/)
_higher-order reducer to ignore redux actions_
[can be used to avoid performance problems in large apps by skipping reducer subtrees](https://twitter.com/dan_abramov/status/656049225566920704)
## Installation
```
npm install --save redux-ignore
```
## API
```js
import { ignoreActions, filterActions } from 'redux-ignore';
ignoreActions(reducer, [ARRAY_OF_ACTIONS])
ignoreActions(reducer, (action) => !action.valid)
filterActions(reducer, [ARRAY_OF_ACTIONS])
filterActions(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`:
```js
// 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:
```js
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:
```js
combineReducers({
counter: ignoreActions(counter, (action) => action.type === INCREMENT_COUNTER)
});
```
## Filtering Actions
You can also use `filterActions` to only accept actions that are declared in an array, or that satisfy the predicate function:
```js
import { combineReducers } from 'redux';
import { filterActions } from 'redux-ignore'; // pull in the filterActions function
import { STAY_COOL, KEEP_CHILLIN } from './actions';
import { counter, notACounter } from './reducers';
combineReducers({
counter: filterActions(counter, (action) => action.type.match(/COUNTER$/)), // only run on actions that satisfy the regex
notACounter: filterActions(notACounter, [STAY_COOL, KEEP_CHILLIN]) // only run for these specific relaxing actions
});
```
## What is this magic? How does it work?
Have a read of the [Implementing Undo History recipe](https://redux.js.org/recipes/implementing-undo-history/)
in the Redux documents, which explains in detail how higher-order reducers work.
## License
MIT, see `LICENSE.md` for more information.