Liking cljdoc? Tell your friends :D
All platforms.

com.fulcrologic.fulcro.algorithms.lookup

Fulcro is quite customizable, and all of the pluggable algorithms are stored on the app. This very easily leads to a desire to alias the long com.fulcrologic.fulcro.application namespace to something like app for easy access to keyword aliasing, but in Clojure this leads to circular references. This namespace exists simply to save typing and hassle with respect to that. It includes app-algorithm which can look up a plug-in algorithm on an app using a simple keyword without having to require the application ns.

Fulcro is quite customizable, and all of the pluggable algorithms are stored on the app. This
very easily leads to a desire to alias the long com.fulcrologic.fulcro.application namespace
to something like `app` for easy access to keyword aliasing, but in Clojure this leads
to circular references. This namespace exists simply to save typing and hassle with
respect to that. It includes `app-algorithm` which can look up a plug-in algorithm on
an app using a simple keyword without having to require the application ns.
raw docstring

app-algorithmclj/s

(app-algorithm {:com.fulcrologic.fulcro.application/keys [algorithms] :as app}
               k)

Get the current value of a particular Fulcro plugin algorithm. These are set by default and can be overridden when you create your fulcro app.

app - The application k - the algorithm to obtain. This can be a plain keyword or a symbol of the algorithm desired.

Supported algorithms that can be obtained/overridden in Fulcro (check the source of app/fulcro-app if you suspect this is out of date, which is likely is):

  • :global-eql-transform - A (fn [tx] tx') that is applied to all outgoing requests (when using default tx!). Defaults to stripping things like :ui/* and form state config joins.
  • :remote-error? - A (fn [result] boolean) that defines what a remote error is.
  • :global-error-action - A (fn [env] ...) that is run on any remote error (as defined by remote-error?).
  • :optimized-render! - The concrete render algorithm for optimized renders (not root refreshes)
  • :render! - The top-level render function. Calls root render or optimized render by default. Renders on the calling thread.
  • :schedule-render! - The call that schedules a render. Defaults to using js/requestAnimationFrame.
  • :default-result-action! - The action used for remote results in all mutations that do not have a result-action section.
  • :index-root! - The algorithm that scans the current query from root an indexes all classes by their queries.
  • :index-component! - The algorithm that adds a component to indexes when it mounts.
  • :drop-component! - The algorithm that removes a component from indexes when it unmounts.
  • :props-middleware - Middleware that can modify props for all components.
  • :render-middleware - Middlware that wraps all render methods of defsc components.
  • :before-render - A function(fn [app RootClass])that is called after a transaction completes, just BEFORE rendering. This function is allowed to affect the state atom to do things like compute dynamic derived state. Prefer this over an atom watch, since it will be called less frequently that an atom watch. This will be called EVEN IF Fulcro is running "headless". So, it can be thought of asafter-transaction`.

Returns nil if the algorithm is currently undefined.

Get the current value of a particular Fulcro plugin algorithm.  These are set by default and can be overridden
when you create your fulcro app.

`app` - The application
`k` - the algorithm to obtain. This can be a plain keyword or a symbol of the algorithm desired.

Supported algorithms that can be obtained/overridden in Fulcro (check the source of app/fulcro-app if you suspect this is out
of date, which is likely is):

- `:global-eql-transform` - A `(fn [tx] tx')` that is applied to all outgoing requests (when using default `tx!`).
   Defaults to stripping things like `:ui/*` and form state config joins.
- `:remote-error?` - A `(fn [result] boolean)` that defines what a remote error is.
- `:global-error-action` - A `(fn [env] ...)` that is run on any remote error (as defined by `remote-error?`).
- `:optimized-render!` - The concrete render algorithm for optimized renders (not root refreshes)
- `:render!` - The top-level render function. Calls root render or optimized render by default. Renders on the calling thread.
- `:schedule-render!` - The call that schedules a render. Defaults to using `js/requestAnimationFrame`.
- `:default-result-action!` -  The action used for remote results in all mutations that do not have a `result-action` section.
- `:index-root!` - The algorithm that scans the current query from root an indexes all classes by their queries.
- `:index-component!` - The algorithm that adds a component to indexes when it mounts.
- `:drop-component!` - The algorithm that removes a component from indexes when it unmounts.
- `:props-middleware` - Middleware that can modify `props` for all components.
- `:render-middleware` - Middlware that wraps all `render` methods of `defsc` components.
- `:before-render - A function `(fn [app RootClass])` that is called after a transaction completes, just BEFORE
  rendering. This function is allowed to affect the state atom to do things like compute dynamic derived state. Prefer
  this over an atom watch, since it will be called less frequently that an atom watch. This will be called EVEN IF
  Fulcro is running "headless". So, it can be thought of as `after-transaction`.

Returns nil if the algorithm is currently undefined.
sourceraw docstring

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

Keyboard shortcutsReport a problemcljdoc on GitHub
× close