Liking cljdoc? Tell your friends :D

brimley.actions

ACTIONS are what the user chose to do from the current menu. these functions are for preparing the arguments for the action chosen by the user, and then executing the action with those arguments.

ACTIONS are what the user chose to do from the current menu.
these functions are for preparing the arguments for the action chosen by the user,
and then executing the action with those arguments.
raw docstring

get-actionclj

(get-action ctx-atm choice)

return the action corresponding to the user's choice given their current path into the menu

return the action corresponding to the user's choice
given their current path into the menu
sourceraw docstring

get-argsclj

(get-args ctx-atm choice)

return the args corresponding to the user's choice given their current path into the menu, and given how they were declared in the menu edn file

return the args corresponding to the user's choice
given their current path into the menu,
and given how they were declared in the menu edn file
sourceraw docstring

perform-action!clj

(perform-action! ctx-atm user-choice)

perform the action chosen by the user on args according to the action's args configuration and the current state of the context atom. if we're calling a user's function, put its result in the context atom

perform the action chosen by the user on args
according to the action's args configuration
and the current state of the context atom.
if we're calling a user's function, put its result
in the context atom
sourceraw docstring

process-argcljmultimethod

gets the value intended to be passed as the real arg to the chosen action, based on the way the arg was declared in the menu edn file:

  • as-is: literally right out of the edn file
  • subst: whatever is found in the ctx-atm at the specified path, even if it's an atom
  • deref: same as subst but assume it is an atom that needs to be deref'd to become an arg to your action
  • dref2: same as deref but assume deref ended with a map, and get a value at a path inside it as the arg.
gets the value intended to be passed as the real arg to the chosen action,
based on the way the arg was declared in the menu edn file:
- as-is: literally right out of the edn file
- subst: whatever is found in the ctx-atm at the specified path, even if it's an atom
- deref: same as subst but assume it is an atom that needs to be deref'd to become an arg to your action
- dref2: same as deref but assume deref ended with a map, and get a value at a path inside it as the arg.
sourceraw docstring

process-arg-at-pathclj

(process-arg-at-path ctx-atm acc key-path)
source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close