keechma.next.controller — keechma/next 0.0.4

api cljs multimethod

Called after init and before start. This function can expose an object that will be passed as a first argument to the API calls. API calls are not wrapped in the transact block automatically.

broadcast cljs

(broadcast controller event)

(broadcast controller event payload)

Broadcasts an event to all running controllers.

call cljs

(call controller controller-name api-fn & args)

controller-dispatcher cljs

(controller-dispatcher c & _)

Dispatcher for controller multimethods that receive the controller config map as it's first argument. Returns the value of the :keechma/controller key in the first argument

derive-state cljs multimethod

This function is called whenever the controller's internal state is changed, or whenever the public state of any of the ancestor controller states is changes. Use this function to calculate the controller's public state. Public state is visible to the subscriptions and other controllers that depend on the controller. It will receive controller's internal state and a map with the states of ancestors. Use this function to derive the state if needed. All descendants and subscriptions will receive the returned value as a payload on the controller's key whenever the value changes

dispatch cljs

(dispatch controller controller-name event)

(dispatch controller controller-name event payload)

Dispatches an event to a controller.

get-api* cljs

(get-api* controller controller-name)

handle cljs multimethod

Called whenever an event is sent to the controller. It receives the controller config map, the command and the command payload as arguments. There is a good possibility that the controller will receive an event it's not handling, so make sure to properly manage this case. Other controllers and UIs can dispatch or broadcast events, and there is no way of knowing if a particular controller handles a particular event.

init cljs multimethod

Called before the controller is started (for each instance of controller, unlike prep). It will receive a controller map as it's only argument. This map will contain controller's config and will be passed to all controller functions as the first argument. This function should return a new controller config. This is a place where you can setup any stateful processes that will be used by the controller. For instance if you want to use go-loop to handle commands sent to controller, this is a place where you would create the incoming channel

prep cljs multimethod

Prep is called once when the app is started (for each controller). It will receive the controller map as it's only argument. It should return a new controller config. This allows you to prep the map for all controller instances that could be created during the app's lifetime.

start cljs multimethod

Called once on the controller start. This function will receive the controller config map and a previous state and should return the initial state synchronously.

stop cljs multimethod

Called once when the controller is stopped. This function will receive the controller config map and the current state and should return the final state. This allows you to preserve any state (if you need to) while the controller is not running. This state will not be visible to any descendants or subscriptions. State returned from the stop function will be passed to the next instance's start function (as the fourth argument)

terminate cljs multimethod

Called on the controller shutdown (after stop). This function is used to cleanup any resources created in the init method. This function is used for side-effects and it's return value is ignored.

transact cljs

(transact controller transaction)

transacted-controller-dispatcher cljs

(transacted-controller-dispatcher c & _)