OrchidSymbiont.Step behaviour (orchid_symbiont v0.2.7)

Copy Markdown View Source

...

Examples

{
  CustomeStep,
  :input, :output,
  [{OrchidSymbiont.Step.get_required(), [foo: :bar]}]
}

Summary

Types

symbiont_map()
symbiont_name()

Callbacks

required()
run_with_model(input, symbiont_map, step_options)

Functions

get_required()
has_model?(step)

Types

symbiont_map()

@type symbiont_map() :: %{required(symbiont_name()) => OrchidSymbiont.Handler.t()}

symbiont_name()

@type symbiont_name() :: atom() | binary()

Callbacks

required()

@callback required() :: [symbiont_name()]

run_with_model(input, symbiont_map, step_options)

@callback run_with_model(Orchid.Step.input(), symbiont_map(), Orchid.Step.step_options()) ::
  Orchid.Step.output()

Functions

get_required()

has_model?(step)