Usage

This is a Simple Store for meteor inspired by Facebook Flux, by using EventEmitter and ReactiveVar

FluxStore

FluxDispatcher

It is an extension for EventEmitter, but I made below changes to it.

FluxDispatcher.defineEvents(eventsMap)

It defines the events map and specify its check matchers (refer to the official package ‘check’)

  FluxDispatcher.defineEvents({
    event1: {
      _id: String,
      updated: {
        score: Match.Integer
      }
    }
  });

You must define all the events before you can use FluxDipatcher.on and FluxDispatcher.emit to register or emit an event, otherwise it will throw an error to warn you to define the event first.

FluxDispatcher.on(eventName, listener)

It is a wrap function of EventEmitter.on, but check whether the eventName have been defined by FluxDispatcher.defineEvents.

FluxDispatcher.emit(eventName, event)

It is a wrap function of EventEmitter.emit, but check whether then passed parameter event matcher the checker defined by FluxDispatcher.defineEvents.

FluxStore

This follows the concept introduced by Facebook Flux Store, and FluxStore inherits from Meteor ReactiveDict. So it is reactive!

FluxStore.define(storeName, config)

This is define a store named storeName, you can pass config to configure it like this way:

  FluxStore.define('storeName', {
    deps: {
      Dep1: { name: String },
      Dep2: { score: Match.Integer }
    },
    initStates: {
      name: String
    },
    exports: {
      name: function(){
        return 'state2 default value';
      },
      allUsers: function(){
        return this.deps.Dep1.find(this.states.get('name'));
      }
    },
    registers: {
      event1: {
        this.otherFunction();
      }
    },
    otherFunction: function(a, b){
    
    }
  });

FluxStore.fetch(storeName, config)

After defining stores by FluxStore.define, then you can fetch a given store by calling this function, and configure its deps and init states. It will check whether the passed initStates match the checker defined in initStates, as shown above. It will also check whether the passed deps match the checker defined in deps, as shown above.

  var Store = FluxStore.fetch('store',{
    deps: {
      Dep1: { name: 'A' },
      Dep2: { score: 1000 }
    },
    initStates: {
      currentStatus: '1'
    }
  });
  FluxDispatcher.emit('event1', { _id: '1111', updated: { score: 10 }});
  expect(Store.deps.Dep1).toEqual(newDep1);
  expect(Store.states.get('currentStatus')).toEqual('1');

store.config(config)

This configures store's deps and init states:

  store.config({
    deps: {
      Dep1: newDep1
    },
    initStates: {
      currentStatus: '1'
    }
  })

store.get('stateName')

It gets the export state defined in exports while defining the store. It will throw error if you get a unknown export.

Testing

Please run:

   VELOCITY_TEST_PACKAGES=1 meteor test-packages --driver-package velocity:html-reporter ./