Redux-Pauseable-Store

Derive one redux store from another, then pause it.

Part of React Hibernate

Danger

You probably don't need this library. When used incorrectly it will do more harm than good.

Consider using <PauseableReduxContainer> from React-Pauseable-Containers instead.

Usage

import { createPauseableStore } from 'redux-pauseable-store';

const pauseableStore = createPauseableStore(store, options);

pauseableStore is derived from the original store, or parent store. It can be paused and unpaused at any time. When unpaused, any state updates in the parent store will flow directly into the derived store.

You can subscribe to and dispatch actions to the derived store, just like the original store.

Options

Options can be set at initialization, through helper functions, or by updating the value directly on the store instance.

isPaused (boolean, default: false)

Whether the pauseable store receives state updates from its parent store.

pauseableStore.isPaused;  // boolean
pauseableStore.setPaused(boolean);

canDispatch (tri-state boolean, default: 'warn')

Whether the pauseable store can dispatch actions to its parent store. When enabled, any actions dispatched to the derived store will instead be routed to the parent store. When to set 'warn', a warning will be emitted (but the action will still be dispatched.)

pauseableStore.canDispatch;  // boolean | 'warn'
pauseableStore.setDispatch(boolean | 'warn');

notifyListersOnUnpause (boolean, default: true)

Whether to notify subscribed listeners when the store unpauses, if it was updated while paused. You probably want to keep this enabled.

pauseableStore.notifyListersOnUnpause;  // boolean