Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kamranahmedse/redux-persist-expire
Expiring transformer for redux-persist
https://github.com/kamranahmedse/redux-persist-expire
redux redux-cache redux-persist redux-persist-transform transform
Last synced: 5 days ago
JSON representation
Expiring transformer for redux-persist
- Host: GitHub
- URL: https://github.com/kamranahmedse/redux-persist-expire
- Owner: kamranahmedse
- License: mit
- Created: 2018-09-01T06:47:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-29T06:59:17.000Z (over 1 year ago)
- Last Synced: 2024-09-21T23:21:45.285Z (4 months ago)
- Topics: redux, redux-cache, redux-persist, redux-persist-transform, transform
- Language: JavaScript
- Homepage:
- Size: 138 KB
- Stars: 78
- Watchers: 3
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# redux-persist-expire
[](https://www.npmjs.com/package/redux-persist-expire)
[](http://travis-ci.org/kamranahmedse/redux-persist-expire)
[](http://travis-ci.org/kamranahmedse/redux-persist-expire)
> Expiring transformer for [redux-persist](https://github.com/rt2zz/redux-persist) – Create expiring storage for your Redux stores
## Installation
```javascript
npm install redux-persist-expire
```
## Usage
Create a transform using `expireReducer(reducerKey, config)` where `reducerKey` is the reducer to which expiry is to be applied and configuration can be used to configure expire behavior.
```javascript
const { persistReducer, persistStore } = require('redux-persist');
// Import the transformer creator
const expireReducer = require('redux-persist-expire');
// Create persisted reducers using redux-persist
const persistedReducers = persistReducer({
transforms: [
// Create a transformer by passing the reducer key and configuration. Values
// shown below are the available configurations with default values
expireReducer('preference', {
// (Optional) Key to be used for the time relative to which store is to be expired
persistedAtKey: '__persisted_at',
// (Required) Seconds after which store will be expired
expireSeconds: null,
// (Optional) State to be used for resetting e.g. provide initial reducer state
expiredState: {},
// (Optional) Use it if you don't want to manually set the time in the reducer i.e. at `persistedAtKey`
// and want the store to be automatically expired if the record is not updated in the `expireSeconds` time
autoExpire: false
})
// You can add more `expireReducer` calls here for different reducers
// that you may want to expire
]
},
rootReducer,
);
export const store = createStore(persistedReducers);
export const persist = persistStore(store);
```
## Examples
Here is the configuration for the common usecases
> Expire the item in store if it has not been updated for the past `n` seconds
```javascript
// Reset `preference` key to empty object if it has not been updated for the past hour
expireReducer('preference', {
expireSeconds: 3600
})
```
> Reset an item to empty array after it has not been updated for the past 30 minutes
```javascript
// Reset `preference` key to given defaults if it has not been updated for the past hour
expireReducer('preference', {
expireSeconds: 1800,
expiredState: {
viewType: 'list',
token: ''
}
})
```
> Expire the item in store after 30 minutes of loading it
```javascript
// Reset `users` key to empty array if it had been loaded 30 minutes ago
expireReducer('users', {
persistedAtKey: 'loadedAt',
expireSeconds: 1800,
expiredState: [] // Reset to empty array after expiry
})
// Note that in this case, you have to manually set the `loadedAt` in
// this case e.g. your reducer might look like this
...
case USERS_LOADED:
return {
loadedAt: moment(), // or use (new Date()).toJSON()
users: payload
};
...
```
Feel free to open an issue if you need help with some specific usecase.
## Contributions
* Report issues with problems and suggestions
* Open pull request with improvements
* Spread the word
* Reach out with any feedback [](https://twitter.com/kamranahmedse)
## License
MIT © [Kamran Ahmed](https://twitter.com/kamranahmedse)