Git Product home page Git Product logo

service-middleware's Introduction

@instructure/redux-service-middleware

npm MIT License

Simple redux middleware for registering service objects.

  1. A service is an object or class instance:
const myService = {
  doStuff: (arg1, arg2) => result
}
class MyOtherService {
  doOtherStuff (...args) {
    return result
  }
}
  1. While creating your store, register your services as key/value pairs with the service middleware constructor:
import { applyMiddleware } from 'redux'
import createServiceMiddleware from '@instructure/redux-service-middleware'

applyMiddleware(
  createServiceMiddleware({
    myKey: myService,
    myOtherKey: new MyOtherService()
  })
)
  1. In your action creator, dispatch an action with the following shape:
import { CALL_SERVICE } from '@instructure/redux-service-middleware'

const actionCreator = () => ({
  type: CALL_SERVICE,
  payload: {
    service: 'myKey',
    method: 'doStuff',
    args: [arg1, arg2]
  }
})

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.

service-middleware's People

Contributors

michaelbrewerdavis avatar ryanmt avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.