rt2zz/redux-persist
Redux Persist
redux-persist is a state persistence library for Redux that saves and restores store state to a storage engine to maintain data across sessions. It functions as a state rehydration tool and serialization middleware, loading previously saved application state back into the Redux store during the initialization process.
The library includes a schema migration utility to transform persisted state data from older versions to newer schemas, ensuring compatibility after application updates. It also provides state serialization transformations to modify state objects before they are written to or read from local or remote storage.
The project covers a broad range of persistence lifecycle management, including the ability to filter state using whitelists and blacklists, handle storage errors, and reconcile restored state through configurable merging strategies. It also provides mechanisms to defer interface rendering until the saved state is fully retrieved and restored.
Features
- Persistent Application State - Saves the Redux application state to a storage engine and restores it during the startup process to maintain data across sessions.
- Redux State Persistence - Saves the Redux store to local or remote storage to maintain application data across browser sessions and refreshes.
- Application State Persistences - Saves the application state to a local or remote storage engine to maintain data across sessions.
- Interrupted State Rehydration - Provides the mechanism to retrieve persisted state and re-inject it into the application store during initialization.
- State Rehydration - Loads previously saved application state from a storage engine back into the Redux store during startup.
- Persistence Action Interceptors - Implements middleware to intercept Redux actions and automatically synchronize the current state with the storage engine.
- State Rehydration Tools - Functions as a tool for loading saved application state back into the Redux store during initialization.
- Storage Abstraction Layers - Uses a generic storage interface to enable persistence across various environments like localStorage or AsyncStorage.
- Client-Side State Rehydration - Restores previously saved state back into the Redux store during application startup to maintain the user session.
- Version-to-Version Migrations - Updates the structure of stored state to a new version before it is merged into the application store.
- Data Persistence Management - Enables control over the persistence process, including pausing, resuming, flushing, and purging stored data.
- State Transformation Pipelines - Provides pipelines to transform state objects for storage, supporting encryption and compression.
- Persistence Transformations - Modifies state objects before serialization for storage and restores them to their original format during rehydration.
- Serialization Transformations - Supports custom transformations to modify state objects before they are written to or read from storage.
- State Tree Whitelisting - Provides the ability to specify exactly which slices of the Redux state tree should be persisted to storage.
- Persistence Lifecycle Management - Provides controls to pause, resume, flush, and purge persisted Redux state in the storage engine.
- State Serialization - Modifies state objects during serialization and deserialization to support custom data types, encryption, or compression.
- Persisted State Schema Migration - Transforms stored state into a newer schema version using a sequence of migration functions or custom handlers.
- State Version Migrations - Includes a schema migration utility to transform stored state data from older versions to newer schemas.
- Rehydration Reconciliation Strategies - Provides configurable merging strategies to resolve conflicts when restoring persisted state into the store.
- Partial State Merging - Implements configurable shallow merging to combine persisted state with the initial application state without losing data.
- Persistence Middleware - Acts as a serialization middleware to filter and transform state before it is written to storage.
- Store Persistence - Listed in the “Store Persistence” section of the Awesome Redux awesome list.
