deepstate.action — com.github.mccraigmccraig/deepstate 0.0.47

action-context-provider cljs macro

(action-context-provider & args)

a ContextProvider element to provide an action-context

props:

• context - the action-context React context
• initial-arg - the initial state value
• children - only the first child will be included as a child of the ContextProvider element

ActionContextProvider cljs

create-action-context cljs

(create-action-context)

create the React Context object

def-action cljs macro

(def-action key [state-bindings action-bindings] effects-map)

define a generic action handler

• key : the action key
• state-bindings : fn bindings to destructure the state
• action-bindings : fn bindings to destructure the action
• effects-map : a form which evaluates to an action-effects map. can use the action-bindings

def-state-action cljs macro

(def-state-action key bindings state-effect-map)

define an action handler with only state effects

• key : the action key
• state-bindings : fn bindings to destructure the state
• action-bindings : fn bindings to destructure the action
• state-effect-map : a form which evaluates to a state map. can use the action-bindings

handle cljs multimethod

handle a possibly asynchronous action

macros such as def-action, def-state-action, deepstate.action.async/def-async-action and deepstate.action.axios/def-axios-action provide sugar creating implementations of this multimethod

• action : the action map. must have key ::action which identifies the handler multimethod

returns:

  `action-effects-fn` = (f state) -> `action-effects`

  `action-effects` = {::state <state>
                      ::navigate <url>
                      ::dispatch <action-map>|[<action-map>]
                      ::later Promise<action-effects-fn>}

i.e. handle returns a fn of state which, when invoked, returns a map of (all optional) effects, including

• ::state - updated state
• ::navigate - a url to navigate to
• ::dispatch - further action maps to dispatch
• ::later - a Promise of another action-effects fn

sig4975 cljs

use-action cljs

(use-action ctx)

(use-action ctx path)

get a state value and dispatch fn

• ctx - the action context
• path - optional path into state for returned state value

returns: [state dispatch]

use-action-context cljs

(use-action-context ctx)

get the value from an action-context

use-action-dispatch cljs

(use-action-dispatch ctx)

get a dispatch fn

• ctx - the action context

use-action-state cljs

(use-action-state ctx)

(use-action-state ctx path)

extract the value at path (default nil) in the current state from an action-context