Clarify comment in quickstart's Application.getStateFromFlux

[binarymuse]

Clarify comment in quickstart's Application.getStateFromFlux

[BinaryMuse]

Thanks for asking; I'd like to make this a little more clear in the docs.

Presumably, if you had a TodoStore and a UserStore and a FooBarStore, you might need to have data from all of them mixed into your object; you could keep them separate by returning an object with a different key per store:

getStateFromFlux: function() {
    var flux = this.getFlux();
    return {
      todoData: flux.store("TodoStore").getState(),
      userData: flux.store("UserStore").getData(),
      fooBarData: flux.store("FooBarStore").someMoreData()
    };
  },

But because the demo app only has a single store, we're just using the data from the store directly (without placing it behind a special todoData key).

Does that help?

[Kobold]

Cool, yah! I tried rephrasing it but I really just prefer your example. How does this sound to you?

getStateFromFlux: function() {
    var flux = this.getFlux();
    // You'll likely return state data from multiple stores in an actual
    // application, e.g.
    // return {
    //   todoData: flux.store("TodoStore").getState(),
    //   userData: flux.store("UserStore").getData(),
    //   fooBarData: flux.store("FooBarStore").someMoreData()
    // };
    return flux.store("TodoStore").getState();
  },

[BinaryMuse]

Thanks, @Kobold, that's a fine idea. This has been updated on the site.