Middleware Data Object

Middleware functions are only as powerful as the data they have access to. Fortunately TrebleGSM allows Middleware functions to access a plethora of Store data to be used by their logic.

TrebleGSM passes the middlewareData object to all Middleware functions with the exception of the payloadListener. From this object you have access to many dispatch and state data.

Property Reference

Below are all properties that are included in the middlewareData object.

dispatchValue

Stores the current dispatched value. This value can change as it goes down the middleware pipeline. It is best practice to not change the dispatchValue value type.

dispatchPayload

Stores the raw dispatch payload data that is returned from a dispatcher method. This is the only property that can be accessed by a payloadListener middleware.

initialDispatchValue

This property is the initial dispatched value. Even if the dispatchValue changes, Middleware will always have access to the original dispatched value.

action

The state action for the dispatched state.

features

Gives middleware access to all features set in the dispatched state’s Store item. This is handy if there are feature flags set that middleware might need to be aware of.

currentState

The current state value of the Store item.

initialState

The initial state value of a Store item. This can be used to reset state to its initial value.

storeItems

Returns an array of current Store items.

storeState

Returns an array of current Store state.

storeModules

Returns an array of Store modules.

dispatchers

Allows middleware functions to access all Store dispatchers. This allows a middleware function to literally update Store state by itself.