# @connected-home/redux-persist-transform-filter-immutable

> Filter transformator for redux-persist supporting immutable.js

Latest version **2.0.0** (published 2018-09-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @connected-home/redux-persist-transform-filter-immutable
pnpm add @connected-home/redux-persist-transform-filter-immutable
yarn add @connected-home/redux-persist-transform-filter-immutable
bun add @connected-home/redux-persist-transform-filter-immutable
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2018-09-25 |
| First published | 2018-09-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 12.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Connected Home |
| Maintainers | beavis07, bgo2, jamiedixon, lithin, sandfox |
| Keywords | react, redux, redux-persist, redux-persist-transform, transform, filter, immutable |

## Links

- npm: https://www.npmjs.com/package/@connected-home/redux-persist-transform-filter-immutable
- Repository: https://github.com/ConnectedHomes/redux-persist-transform-filter-immutable
- Homepage: https://github.com/ConnectedHomes/redux-persist-transform-filter-immutable#readme
- Issues: https://github.com/ConnectedHomes/redux-persist-transform-filter-immutable/issues
- npm.io page: https://npm.io/package/@connected-home/redux-persist-transform-filter-immutable

## Dependencies (11)

- [immutable](https://npm.io/package/immutable.md) ^4.0.0-rc.9
- [lodash.get](https://npm.io/package/lodash.get.md) ^4.4.2
- [lodash.set](https://npm.io/package/lodash.set.md) ^4.3.2
- [lodash.forin](https://npm.io/package/lodash.forin.md) ^4.4.0
- [lodash.unset](https://npm.io/package/lodash.unset.md) ^4.5.2
- [lodash.pickby](https://npm.io/package/lodash.pickby.md) ^4.6.0
- [lodash.isempty](https://npm.io/package/lodash.isempty.md) ^4.4.0
- [lodash.includes](https://npm.io/package/lodash.includes.md) ^4.3.0
- [lodash.isobject](https://npm.io/package/lodash.isobject.md) ^3.0.2
- [lodash.isstring](https://npm.io/package/lodash.isstring.md) ^4.0.1
- [lodash.isundefined](https://npm.io/package/lodash.isundefined.md) ^3.0.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2018-09-25

## README

# redux-persist-transform-filter-immutable

[![npm](https://img.shields.io/npm/v/@actra-development-oss/redux-persist-transform-filter-immutable.svg?maxAge=2592000&style=flat-square)](https://www.npmjs.com/package/redux-persist-transform-filter-immutable)
[![Build Status](https://travis-ci.org/actra-development-oss/redux-persist-transform-filter-immutable.svg?branch=master)](https://travis-ci.org/actra-development-oss/redux-persist-transform-filter-immutable)

Filter transformator for redux-persist supporting immutable.js

## Installation
```
  npm install @actra-development-oss/redux-persist-transform-filter-immutable
```

## Usage

```js
import { createFilter, createBlacklistFilter } from 'redux-persist-transform-filter-immutable';

// this works too:
import createFilter, { createBlacklistFilter } from 'redux-persist-transform-filter-immutable';

// you want to store only a subset of your state of reducer one
const saveSubsetFilter = createFilter(
    'myReducerOne',
    ['keyYouWantToSave1', 'keyYouWantToSave2']
);

// you want to remove some keys before you save
const saveSubsetBlacklistFilter = createBlacklistFilter(
    'myReducerTwo',
    ['keyYouDontWantToSave1', 'keyYouDontWantToSave2']
);

// you want to load only a subset of your state of reducer two
const loadSubsetFilter = createFilter(
    'myReducerThree',
    null,
    ['keyYouWantToLoad1', 'keyYouWantToLoad2']
);

// saving a subset and loading a different subset is possible
// but doesn't make much sense because you'd load an empty state
const saveAndloadSubsetFilter = createFilter(
    'myReducerFour',
    ['one', 'two']
    ['three', 'four']
);

persistStore(store, {
    transforms: [
        saveSubsetFilter,
        saveSubsetBlacklistFilter,
        loadSubsetFilter,
        saveAndloadSubsetFilter,
    ]
});
```

## Thanks

Thanks to Eduard Baun for [redux-persist-transform-filter](https://github.com/edy/redux-persist-transform-filter) - on which this implementation is based.
Thanks to Zack Story for [redux-persist](https://github.com/rt2zz/redux-persist) from which I took createTransform().

---
_Source: https://npm.io/package/@connected-home/redux-persist-transform-filter-immutable · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._