Store

A store is created via the createStore API. A store instance contains the following properties.

• addModel (Function)

  Allows you to dynamically add a "slice" to your model. Useful in applications adopting code splitting strategies that wish to dynamically load slices of their models as required.

  const store = createStore(model);
  store.addModel('todos', {
    items: ['Buy shoes'],
  });
  store.getState().todos.items; // ["Buy shoes"]
  

• clearMockedActions (Function)

  If the mockActions configuration value was passed to the createStore then calling this function clears the list of mocked actions that have been tracked by the store. This is useful in the context of testing - especially thunks and listeners.

• dispatch (Function)

  Allows you to manually dispatch actions, ala Redux.

• getActions (Function)

  Returns the actions of your store.

• getListeners (Function)

  Returns the listener actions of your store (i.e. actionOn and thunkOn). Useful if you would like to manually execute a listener for the purpose of testing.

• getMockedActions (Function)

  If the mockActions configuration value was passed to the createStore then calling this function will return the actions that have been dispatched (and mocked). This is useful in the context of testing - especially thunks and listeners.

• getState (Function)

  Returns the state of your store.

• reconfigure (Function)

  Allows you to reconfigure the store by providing a new/updated model. The existing state of the store will be maintained. This is especially useful in supporting hot reloading.

  const store = createStore(model);
  store.reconfigure(newModel);
  

• removeModel (Function)

  Allows you to dynamically remove a "slice" from your model. Useful in applications adopting code splitting strategies that wish to dynamically remove a slices of their model when a specific component tree unmounts.

  const store = createStore(model);
  store.removeModel('todos');
  store.getState().todos; // undefined