drbuchkov.re-xstate.core — io.github.drbuchkov/re-xstate 0.0.8-1-g03cfbc0

actor-send! cljs

(actor-send! [actor message])

Sends message to xstate actor

actor-start! cljs

(actor-start! {:keys [actor]})

Starts xstate actor.

actor-stop! cljs

(actor-stop! actor)

Stops xstate actor.

actor-subscribe! cljs

(actor-subscribe! {:keys [actor] {:keys [id]} :config})

Adds a listener to the actor to listen to state changes.

evt->edn cljs

(evt->edn evt)

Converts the xstate event object to edn.

get-fsm cljs

(get-fsm db [_ fsm-id])

Returns the FSM by id from db.

get-fsm-actor cljs

(get-fsm-actor db [_ fsm-id])

Returns the xstate actor of the FSM from db.

get-fsm-config cljs

(get-fsm-config db [_ fsm-id])

Returns the config of the FSM from db.

get-fsm-context cljs

(get-fsm-context db [_ fsm-id])

Returns the context of the FSM from db.

get-fsm-machine cljs

(get-fsm-machine db [_ fsm-id])

Returns the xstate machine of the FSM from db.

get-fsm-state cljs

(get-fsm-state db [_ fsm-id])

Returns the current state as a js object (returned by XState) of the FSM from db.

get-fsm-state-map cljs

(get-fsm-state-map db [_ fsm-id])

Returns the current state as a clojure map from db.

initialize-fsm cljs

(initialize-fsm {:keys [db]} [{:keys [id context] :as fsm-config} fsm-options])

Initializes the FSM and updates the db with the FSM map.

normalize-actions cljs

(normalize-actions actions)

Normalizes the actions by converting the type to a keyword.

on-state cljs

(on-state fsm-id)

Xstate actor subscribe listener, dispatches ::update-state event

run-effectful-action! cljs

(run-effectful-action! [effect evt])

Runs the effectful action function, given the event.

send cljs

(send {:keys [db]} [fsm-id {:keys [type] :as message}])

Dispatches an effect to send a message to a xstate actor. fsm-id, transition-actions and ctx are injected to the message.

transition cljs

(transition db [_ fsm-id state message])

Returns the new state given app-db, fsm-id, current state, and message

transition-params cljs

(transition-params action-id transition-actions)

Returns the params for the given action-id in the transition-actions property that's injected from the send event into the message.

update-context cljs

(update-context {:keys [db]} [{:keys [fsm-id] :as evt} action-fn])

Given a ctx-action function and an event, updates the context of the FSM in the db. This is used instead of the default xstate context updating, because the default xstate context updating doesn't work with re-frame subscriptions, and converting from edn to json and back results in a loss of data.

update-state cljs

(update-state {:keys [db]} [fsm-id state])

Updates the state of the FSM in the db. Dispatches action events on transition if any.

wrap-ctx-action cljs

(wrap-ctx-action action-fn)

Given a context action function, returns a 2-arity callback that can be used as an xstate action. The event is converted to edn before being passed to the action function.

wrap-effectful-action cljs

(wrap-effectful-action action-fn)

Given an effectful action function, returns a 2-arity callback that can be used as an xstate action. The event is converted to edn before being passed to the action function.

wrap-guard cljs

(wrap-guard guard-fn)

Given a function that takes an event and returns a boolean, returns a 2-arity callback that can be used as an xstate guard. The event is converted to edn before being passed to the guard function.

xstate-state->clj cljs

(xstate-state->clj state)

Returns the xstate state object as a clojure map.