Code Monkey home page Code Monkey logo

flux-react-dispatcher's Introduction

Build Status

React Dispatcher

Part of flux-react, the dispatcher will let stores register to it with callbacks. Read more about FLUX and the dispatcher over at Facebook Flux.

Download from dist: ReactDispatcher.min.js or install with npm install flux-react-dispatcher.

Scope

  • Has a register method for registering callbacks to stores
  • Has a dispatch method for dispatching a payload to all stores
  • The callback on register receives the payload and a waitFor function
  • The waitFor function is used to wait for specific stores to finish their registered callback before continuing
  • The waitFor method gives errors if circular dependencies occur
  • The waitFor callback is bound to the store and receives the payload, for conveniance
  • The waitFor method takes either a single store or an array of stores
  • The dispatcher works with common module loaders

Example

var ReactDispatcher = require('flux-react-dispatcher');
var Dispatcher = new ReactDispatcher();

var StoreA = {
	dispatch: function () {}
};

var StoreB = {
	data: {},
	handleData: function (payload) {
		this.data = payload.data;
	},
	dispatch: function (payload, waitFor) {
		switch (payload.type) {
			case 'update':
				waitFor(StoreA, this.handleData);
				break;
		}
	}

};
Dispatcher.register(StoreA, StoreA.dispatch); // Binds the callback to the store
Dispatcher.register(StoreB, StoreB.dispatch);
Dispatcher.dispatch({});

Contribute

Develop

  • Run npm install
  • Run gulp
  • Any changes to files in app/ will be compiled to dev/

Test

  • Run `gulp test -'./tests/ReactDispatcher-test.js'
  • Open the test.html file in your browser
  • Any changes to files in app/ and the test file will autoreload the browser

Run test in terminal

  • Run npm test
  • Currently uses phantomJS, though you can use chrome

flux-react-dispatcher's People

Contributors

christianalfoni avatar gmkohler avatar sheerun avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

mcsf sheerun

flux-react-dispatcher's Issues

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.