#
View Source Ash.Flow.Step behaviour (ash v2.4.22)

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

Link to this callback

# describe(opts)

View Source (optional)

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

Link to this callback

# run(input, opts, context)

View Source

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

Link to this callback

# short_name(opts)

View Source (optional)

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