Liking cljdoc? Tell your friends :D

state-flow.core


as-step-fnclj

(as-step-fn flow)

Transform a flow step into a state transition function

Transform a flow step into a state transition function
raw docstring

current-descriptionclj

(current-description)

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

For internal use. Subject to change.

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

For internal use. Subject to change.
raw docstring

flowcljmacro

(flow description & flows)

Defines a flow

Defines a flow
raw docstring

flow*clj

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

modify-metaclj

(modify-meta f & args)

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

For internal use. Subject to change.

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

For internal use. Subject to change.
raw docstring

pop-metaclj

(pop-meta)

push-metaclj

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

Returns a flow that will modify the state metadata.

For internal use. Subject to change.

Returns a flow that will modify the state metadata.

For internal use. Subject to change.
raw docstring

runclj

(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.

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.
raw docstring

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

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

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

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
raw docstring

top-level-descriptionclj

(top-level-description s)

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

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

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

× close