space.matterandvoid.subscriptions.impl.fulcro — space.matterandvoid/subscriptions 2022.10.17

<sub clj/s

(<sub app query)

Subscribe and deref a subscription, returning its value, not a reaction.

app-state-key clj/s

cache-lookup clj/s

(cache-lookup app cache-key)

cleanup! clj/s

(cleanup! this)

Intended to be called when a component unmounts to clear the registered Reaction.

clear-handlers clj/s

(clear-handlers _app)

(clear-handlers _app id)

clear-sub clj/s

(clear-sub registry)

(clear-sub registry query-id)

clear-subscription-cache! clj/s

(clear-subscription-cache! registry)

deflayer2-sub clj macro

(deflayer2-sub meta-sub-kw sub-name ?path)

Takes a symbol for a subscription name and a way to derive a path in your fulcro app db. Returns a function subscription which itself returns a Reagent RCursor. Supports a vector path, a single keyword, or a function which takes the RAtom datasource and the arguments map passed to subscribe and must return a path vector to use as an RCursor path.

Examples:

(deflayer2-sub my-subscription :a-path-in-your-db)

(deflayer2-sub my-subscription [:a-path-in-your-db])

(deflayer2-sub my-subscription (fn [db-atom sub-args-map] [:a-key (:some-val sub-args-map])))

deref-input-signals clj/s

dispose-current-reaction! clj/s

(dispose-current-reaction! this)

get-cache-key clj/s

(get-cache-key app query-v)

get-component-reaction clj/s

(get-component-reaction this)

get-handler clj/s

(get-handler id)

Returns a "handler" function registered for the subscription with the given id. Fulcro app and 'query-id' -> subscription handler function. Lookup in the place where the query-id -> handler functions are stored.

get-input-db-signal clj/s

(get-input-db-signal app)

Given the storage for the subscriptions return an atom containing a map (this it the 'db' in re-frame parlance). this assumes you've set your fulcro app's state-atom to be reagent reactive atom.

get-subscription-cache clj/s

(get-subscription-cache app)

handler-registry_ clj/s

parse-reg-sub-args clj/s

(parse-reg-sub-args args)

reaction-callback clj/s

(reaction-callback this)

reaction-key clj/s

refresh-component! clj/s

(refresh-component! this)

reg-layer2-sub clj/s

(reg-layer2-sub query-id path-vec-or-fn)

Registers a handler function that returns a Reagent RCursor instead of a Reagent Reaction. Accepts a single keyword, a vector path into or a function which takes your db atom and arguments map passed to subscribe and must return a vector path to be used for the cursor.

reg-sub clj/s

(reg-sub query-id & args)

reg-sub-raw clj/s

(reg-sub-raw query-id handler-fn)

register-handler! clj/s

(register-handler! id handler-fn)

Returns handler-fn after associng it in the map.

remove-reaction! clj/s

(remove-reaction! this)

set-args-merge-fn! clj/s

(set-args-merge-fn! f)

set-memoize-fn! clj/s

(set-memoize-fn! f)

setup-reaction! clj/s

(setup-reaction! this client-render)

Installs a Reaction on the provided component which will re-render the component when any of the subscriptions' values change.

state-key clj/s

state-path clj/s

(state-path)

(state-path k)

(state-path k v)

sub-fn clj/s

(sub-fn meta-fn-key f)

Takes a function that returns either a Reaction or RCursor. Returns a function that when invoked delegates to f and derefs its output. The returned function can be used in subscriptions.

subs-cache->fulcro-app-state clj/s

(subs-cache->fulcro-app-state app)

subs-cache_ clj/s

subs-key clj/s

subs-state-path clj/s

(subs-state-path k v)

subscribe clj/s

(subscribe ?app query)

Given a query vector, returns a Reagent reaction which will, over time, reactively deliver a stream of values. Also known as a Signal.

To obtain the current value from the Signal, it must be dereferenced