thunks.md

The thunkMiddleware packaged with Rodux will intercept any action dispatched to our store that is a Lua function and execute that function instead of forwarding our action to the reducer. These functions (also called thunks) have access to the store and are allowed to dispatch action objects themselves as necessary.

local reducer = function(state, action)
	--[[
		Reducer that handles all actions for our store,
		including actions of the type "MadeNewFriends".
	]]
end

local initialState = {}

local store = Rodux.Store.new(reducer, initialState, {
	Rodux.thunkMiddleware,
})

--[[
	Our thunkMiddleware will process this action as a thunk
	since it is a Lua function
]]
store:dispatch(function(store)
	getAsyncNewFriendsForUser("Sarah", function(result)
		store:dispatch({
			type = "MadeNewFriends",
			newFriends = result,
		})
	end)
end)

Thunks are a simple way to introduce more complex processing of action objects, but you may want to consider creating custom middleware for complex features instead of relying on thunks alone.

It is also possible to inject a custom argument into the thunk middleware. This is useful for cases like using an API service layer that could be swapped out for a mock service in tests. This is accomplished by using the Rodux.makeThunkMiddleware API instead:

local myThunkMiddleware = Rodux.makeThunkMiddleware(myCustomArg)
local store = Rodux.Store.new(reducer, initialState, {
	myThunkMiddleware,
})

store:dispatch(function(store, myCustomArg)
	print("Hello from a thunk with extra argument:", myCustomArg)
	store:dispatch({
		type = "thunkAction"
	})
end)

If multiple values need to be passed in, they can be combined into a single table:

local myThunkMiddleware = Rodux.makeThunkMiddleware({
    [RoactNetworking] = networking,
    AvatarEditorService = AvatarEditorService,
})