Liking cljdoc? Tell your friends :D
ClojureScript only.

fonda.core


executecljs

(execute config steps ctx on-success on-anomaly on-exception)

Sequentially executes the series of given steps.

Each step function - tap or processor - can be synchronous or asynchronous.

  • config: A map with:

    • [opt] anomaly? A function that gets a map and determines if it is an anomaly.
    • [opt] log-exception A function gets called with the FondaContext record when there is an exception.
    • [opt] log-anomaly A function that gets called with the FondaContext record when a step returns an anomaly.
    • [opt] log-success A function that gets called with the FondaContext record after all steps succeeded.
    • [opt] initial-ctx The context data initializes the context. Must be a map.
  • steps: Each item on the steps collection must be either a Tap, or a Processor.

    Tap:

    • tap: A function that gets the context but doesn't augment it.
    • name: The name of the step

    Processor:

    • processor: A function that gets the context and assocs the result into it on the given path
    • path: Path where to assoc the result of the processor
    • name: The name of the step
  • ctx The runtime context, merged to the initial context. Must be a map.

  • on-success Callback that gets called with the context if all the steps succeeded.

  • on-anomaly Callback that gets called with an anomaly when any step returns one.

  • on-exception Callback that gets called with an exception when any step triggers one.

Sequentially executes the series of given `steps`.

Each step function - tap or processor - can be synchronous or asynchronous.

- `config`: A map with:
    - [opt] anomaly?      A function that gets a map and determines if it is an anomaly.
    - [opt] log-exception A function gets called with the FondaContext record when there is an exception.
    - [opt] log-anomaly   A function that gets called with the FondaContext record when a step returns an anomaly.
    - [opt] log-success   A function that gets called with the FondaContext record after all steps succeeded.
    - [opt] initial-ctx   The context data initializes the context. Must be a map.

- `steps`: Each item on the `steps` collection must be either a Tap, or a Processor.

    Tap:
     - tap:  A function that gets the context but doesn't augment it.
     - name: The name of the step

    Processor:
     - processor: A function that gets the context and assocs the result into it on the given path
     - path:     Path where to assoc the result of the processor
     - name:     The name of the step

- `ctx`          The runtime context, merged to the initial context. Must be a map.
- `on-success`   Callback that gets called with the context if all the steps succeeded.
- `on-anomaly`   Callback that gets called with an anomaly when any step returns one.
- `on-exception` Callback that gets called with an exception when any step triggers one.
sourceraw docstring

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

× close