/redux-persist-transform-expire

Add expiration to your persisted store

Primary LanguageJavaScriptMIT LicenseMIT

redux-persist-transform-expire

npm

Add expiration to your persisted store.

Usage

import createExpirationTransform from 'redux-persist-transform-expire';

const expireTransform = createExpirationTransform({
  expireKey: 'customExpiresAt',
  defaultState: {
    custom: 'values'
  }
});

persistStore(store, {
  transforms: [expireTransform]
});

Your expires key should be present in each reducer, which should be expired. E.g.

// top most reducer
{
  reducerOne: {
    persistExpiresAt: '2017-04-11T15:46:54.338Z'
  },
  reducerTwo: {
    persistExpiresAt: '2017-04-11T15:46:54.338Z'
  }
}

Configuration

Attr Type Default Notes
expireKey String 'persistExpiresAt' Name of the attribute holding the expire date value
defaultState Any {} Shape of the state after expirations happen