A middleware for redux that buffers all actions into a queue until a breaker condition is met, at which point the queue is released (i.e. actions are triggered).
One potential use case for this is to buffer any actions that occur before you are finished initializing your app. For example in conjunction with redux-persist.
import createActionBuffer from 'redux-action-buffer'
let breaker = BREAKER_ACTION_TYPE
let actionBuffer = createActionBuffer(
BREAKER_ACTION_TYPE,
(err, data) => {
// callback fired immediately after releasing the buffer
// data: { results: [actionReturnValue], queue: [rawAction] }
}
)
In short:
createActionBuffer({ breaker: REHYDRATE, passthrough: [PERSIST] })
Full example:
import { REHYDRATE } from 'redux-persist'
import createActionBuffer from 'redux-action-buffer'
import { createStore, compose } from 'redux'
let enhancer = compose(
autoRehydrate(),
applyMiddleware(
createActionBuffer(REHYDRATE) //make sure to apply this after redux-thunk et al.
)
)
createStore(
reducer,
{},
enhancer
)
Delaying actions can be tricky because many actions depend on having a return value, and buffering breaks that. To help catch this scenario the return value from all buffered actions is a string indicating the action has been buffered.
actionBuffer(options, callback)