state-flow.state — nubank/state-flow 5.13.2

ensure-step clj

(ensure-step value)

Internal use only.

Given a state-flow step, returns value as/is, else wraps value in a state-flow step.

error-catching-state clj

(error-catching-state mfn)

eval clj

exec clj

fmap clj

(fmap f flow)

Creates a flow that returns the application of f to the return of flow

get clj

(get)

Creates a flow that returns the value of state.

gets clj

(gets)

(gets f & args)

Creates a flow that returns the result of applying f (default identity) to state with any additional args.

invoke clj

(invoke my-fn)

Creates a flow that invokes a function of no arguments and returns the result. Used to invoke side effects e.g.

(state-flow.core/invoke #(Thread/sleep 1000))

modify clj

(modify f & args)

Creates a flow that replaces state with the result of applying f to state with any additional args.

put clj

(put new-state)

Creates a flow that replaces state with new-state.

return clj

(return v)

Creates a flow that returns v. Use this as the last step in a flow that you want to reuse in other flows, in order to clarify the return value, e.g.

(def increment-count (flow "increments :count and returns it" (state/modify update :count inc) [new-count (state/gets :count)] (state-flow/return new-count)))

run clj

short-circuiting-context clj

Same as state monad context, but short circuits if error happens, place error in return value

state? clj

swap clj deprecated

(swap f)

DEPRECATED: use state-flow.state/modify instead.

when clj

(when e flow)

Given an expression e and a flow, if the expression is logical true, return the flow. Otherwise, return nil in a monadic context.

wrap-fn clj deprecated

DEPRECATED: Use state-flow.state/invoke instead.