state-flow.core — nubank/state-flow 2.2.3

as-step-fn clj

(as-step-fn flow)

Transform a flow step into a state transition function

current-description clj

(current-description)

Returns a flow that returns the description as of the point of execution.

For internal use. Subject to change.

flow clj macro

(flow description & flows)

Defines a flow

flow* clj

(flow* {:keys [description caller-meta]} & flows)

modify-meta clj

(modify-meta f & args)

Returns a monad that will apply vary-meta to the world.

For internal use. Subject to change.

pop-meta clj

(pop-meta)

push-meta clj

(push-meta description {:keys [line]})

Returns a flow that will modify the state metadata.

For internal use. Subject to change.

run clj

(run flow)

(run flow initial-state)

Given an initial-state (default {}), runs a flow and returns a pair of the result of the last step in the flow and the end state.

run! clj

(run! flow)

(run! flow initial-state)

Like run, but prints a log and throws an error when the flow fails with an exception

run* clj

(run* {:keys [init cleanup runner]
       :or {init (constantly {}) cleanup identity runner run!}}
      flow)

Run a flow with specified parameters

Receives optional parameter maps init, a function with no arguments that returns the initial state. cleanup, function receiving the final state to perform cleanup if necessary runner, function that will receive a flow and an initial state and execute the flow

top-level-description clj

(top-level-description s)

Returns the description passed to the top level flow (or the stringified symbol passed to defflow).