Registry /
storage / redux-storage-decorator-filter
Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
filter
✓ import filter from 'redux-storage-decorator-filter'
✗ import { filter } from 'redux-storage-decorator-filter'
Default export only; named import will not work.
filter (default import via require)
✓ const filter = require('redux-storage-decorator-filter').default
✗ const filter = require('redux-storage-decorator-filter')
CommonJS require returns an object with a default property since the package uses ES modules.
FilterDecorator (type import for TypeScript)
✓ import FilterDecorator from 'redux-storage-decorator-filter';
type Engine = any; // no TS types provided
✗ import { FilterDecorator } from 'redux-storage-decorator-filter'
Package has no TypeScript declarations; use any type.
Shows how to create a filtered redux-storage engine that persists only whitelisted state keys.
import filter from 'redux-storage-decorator-filter';
import createEngine from 'redux-storage-engine-localstorage';
// Create a base engine
const baseEngine = createEngine('my-app');
// Only persist 'auth' and 'settings.theme' (nested)
const filteredEngine = filter(baseEngine, [
'auth',
['settings', 'theme']
], []);
// Use filteredEngine with redux-storage middleware
import { createStore, applyMiddleware } from 'redux';
import * as storage from 'redux-storage';
const reducer = storage.reducer(combineReducers({ /* ... */ }));
const middleware = storage.createMiddleware(filteredEngine);
const store = createStore(reducer, applyMiddleware(middleware));
// Load persisted state
storage.createLoader(filteredEngine)(store);
Errors
Common errors & fixes
Cannot find module 'redux-storage-decorator-filter'
Package not installed or import path incorrect.
fixnpm install redux-storage-decorator-filter --save
TypeError: filter is not a function
Importing as named export instead of default.
fixUse import filter from 'redux-storage-decorator-filter'
Error: Invalid engine provided to filter
Engine argument is null or not a valid redux-storage engine.
fixCall filter with a valid engine instance first: const engine = createEngine('key'); filter(engine, ...) Audit
Dependencies
redux-storagerequiredThis is a decorator for redux-storage engine; it wraps an engine instance.