Ash.Flow.Step behaviour (ash v1.52.0-rc.1) View Source

A behaviour for implementing a custom step in a flow.

Link to this section Summary

Callbacks

describe(opts)

run(input, opts, context)

short_name(opts)

Link to this section Callbacks

describe(opts)

(optional)

Specs

describe(opts :: Keyword.t()) :: String.t()

run(input, opts, context)

Specs

run(input :: map() | nil, opts :: Keyword.t(), context :: map()) ::
  {:ok, term()}
  | {:ok, term(),
     %{optional(:notifications) => [Ash.Notifier.Notification.t()]}}
  | {:error, term()}

short_name(opts)

(optional)

Specs

short_name(opts :: Keyword.t()) :: String.t()