View Source Ash.Flow.Step behaviour (ash v2.19.3)

A behaviour for implementing a custom step in a flow.

Summary

Callbacks

describe(opts)

run(input, opts, context)

short_name(opts)

Callbacks

describe(opts)

(optional)

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

run(input, opts, context)

@callback 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)

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