Nepotistic Pontifex Maximus

    redux-batched-subscribe
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/redux-batched-subscribe package

    0.1.6 • Public • Published

    redux-batched-subscribe

    build status npm version

    Store enhancer for redux which allows batching of subscribe notifications that occur as a result of dispatches.

    npm install --save redux-batched-subscribe

    Usage

    The batchedSubscribe store enhancer accepts a function which is called after every dispatch with a notify callback as a single argument. Calling the notify callback will trigger all the subscription handlers, this gives you the ability to use various techniques to delay subscription notifications such as: debouncing, React batched updates or requestAnimationFrame.

    Since batchedSubscribe overloads the dispatch and subscribe handlers on the original redux store it is important that it gets applied before any other store enhancers or middleware that depend on these functions; The compose utility in redux can be used to handle this:

    import { createStore, applyMiddleware, compose } from 'redux';
    import { batchedSubscribe } from 'redux-batched-subscribe';
     
    const enhancer = compose(
      applyMiddleware(...middleware),
      batchedSubscribe((notify) => {
        notify();
      })
    )
     
    // Note: passing enhancer as the last argument to createStore requires redux@>=3.1.0
    const store = createStore(reducer, initialState, enhancer);

    Note: since compose applies functions from right to left, batchedSubscribe should appear at the end of the chain.

    The store enhancer also exposes a subscribeImmediate method which allows for unbatched subscribe notifications.

    Examples

    Debounced subscribe handlers:

    import { createStore } from 'redux';
    import { batchedSubscribe } from 'redux-batched-subscribe';
    import debounce from 'lodash.debounce';
     
    const batchDebounce = debounce(notify => notify());
    const finalCreateStore = batchedSubscribe(batchDebounce)(createStore);
    const store = finalCreateStore(reducer, intialState);

    React batched updates

    import { createStore } from 'redux';
    import { batchedSubscribe } from 'redux-batched-subscribe';
     
    // React <= 0.13
    import { addons } from 'react/addons';
    const batchedUpdates = addons.batchedUpdates;
     
    // React 0.14
    import { unstable_batchedUpdates as batchedUpdates } from 'react-dom';
     
    // Note: passing batchedSubscribe as the last argument to createStore requires redux@>=3.1.0
    const store = createStore(reducer, intialState, batchedSubscribe(batchedUpdates));

    Thanks

    Thanks to Andrew Clark for the clean library structure.

    Install

    npm i redux-batched-subscribe

    DownloadsWeekly Downloads

    46,006

    Version

    0.1.6

    License

    MIT

    Last publish

    Collaborators

    • tappleby