redux-storage-decorator-filter

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

redux-storage-decorator-filter

★ 26 Open GitHub ↗

Filter decorator for redux-storage

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# [redux-storage-decorator-filter][]

[![build](https://travis-ci.org/michaelcontento/redux-storage-decorator-filter.svg?branch=master)](https://travis-ci.org/michaelcontento/redux-storage-decorator-filter)
[![dependencies](https://david-dm.org/michaelcontento/redux-storage-decorator-filter.svg)](https://david-dm.org/michaelcontento/redux-storage-decorator-filter)
[![devDependencies](https://david-dm.org/michaelcontento/redux-storage-decorator-filter/dev-status.svg)](https://david-dm.org/michaelcontento/redux-storage-decorator-filter#info=devDependencies)

[![license](https://img.shields.io/npm/l/redux-storage-decorator-filter.svg?style=flat-square)](https://www.npmjs.com/package/redux-storage-decorator-filter)
[![npm version](https://img.shields.io/npm/v/redux-storage-decorator-filter.svg?style=flat-square)](https://www.npmjs.com/package/redux-storage-decorator-filter)
[![npm downloads](https://img.shields.io/npm/dm/redux-storage-decorator-filter.svg?style=flat-square)](https://www.npmjs.com/package/redux-storage-decorator-filter)

Filter decorator for [redux-storage][] to only store a subset of the whole
state tree.

# Moved to the react-stack organisation

My focus has left the node / react ecosystem and this module has got a new home
over at [react-stack](https://github.com/react-stack/redux-storage-decorator-filter)!

## Installation

npm install --save redux-storage-decorator-filter

## Usage

Simply wrap your engine in this decorator, whitelist all keys that should
be passed through and blacklist the keys that shouldn't.

```js
import filter from 'redux-storage-decorator-filter'

engine = filter(engine, [
    'whitelisted-key',
    ['nested', 'key'],
    ['another', 'very', 'nested', 'key']
], [
    'blacklisted-key',
    ['nested', 'blacklisted-key']
]);
```

## License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of
    this software and associated documentation files (the "Software"), to deal in
    the Software without restriction, including without limitation the rights to
    use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
    the Software, and to permit persons to whom the Software is furnished to do so,
    subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
    FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
    COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
    IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
    CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

[redux-storage]: https://github.com/michaelcontento/redux-storage
  [redux-storage-decorator-filter]: https://github.com/michaelcontento/redux-storage-decorator-filter

redux-storage-decorator-filter

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README