redux-modules-middleware
redux-modules-middleware
is a library that contains commonly used action creator middleware intended for use with the redux-modules
library.
Getting Started
Install
npm install redux-modules-middleware --save
Documentation
decorateMeta
func -> action -> decoratedAction
Decorates the action's meta
key with the provided function.
foo: middleware: { console; // 'meta is now a string!' return state; }
decoratePayload
func -> action -> decoratedAction
Decorates the action's payload
key with the given function.
foo: middleware: { console; // 'payload is now a string!' return state; }
log
({ formatter, logFunction }) -> action -> action
Runs action through formatter
function, then calls the logFunction
.
foo: middleware: // logs `thar be an action yonder { type: foo }`
formatter
should return an array of arguments to be applied to the logFunction
.
swapTypes
object -> action -> decoratedAction
Takes an object where keys are the types to swap, and values are the types to swap them with.
foo: middleware: // action type becomes `bar`
propCheck
(propFunction or object, { logFunction, formatter }) -> action -> action
Takes either a proptype function, or an object where keys are the payload keys, and values are the corresponding proptype functions.
create: middleware: deleteById: middleware:
Usage Example
In this example propCheck and decoratePayload middleware are being used.
src/modules/todos.js
;;;;;const shape string number = PropTypes; name: 'todos' initialState: todos: state transformations: create: middleware: state destroy: middleware: { state } );