@instructure/redux-service-middleware

Simple redux middleware for registering service objects.

1. A service is an object or class instance:

1const myService = {
2  doStuff: (arg1, arg2) => result
3}
4class MyOtherService {
5  doOtherStuff (...args) {
6    return result
7  }
8}

2. While creating your store, register your services as key/value pairs with the service middleware constructor:

1import { applyMiddleware } from 'redux'
2import createServiceMiddleware from '@instructure/redux-service-middleware'
3
4applyMiddleware(
5  createServiceMiddleware({
6    myKey: myService,
7    myOtherKey: new MyOtherService()
8  })
9)

3. In your action creator, dispatch an action with the following shape:

1import { CALL_SERVICE } from '@instructure/redux-service-middleware'
2
3const actionCreator = () => ({
4  type: CALL_SERVICE,
5  payload: {
6    service: 'myKey',
7    method: 'doStuff',
8    args: [arg1, arg2]
9  }
10})

Calls to dispatch with an action of this form will return a promise resolving to the result of calling myService.methodName(arg1, arg2).

License

This project is is released under the MIT license.