Jido.Flow.Choice (Jido Action v3.0.0-beta.12)

View Source

A named, ordered Choice with a required fallback Action.

option =
  Jido.Flow.Choice.Option.new!(
    name: "ready",
    condition: Jido.Expr.new!(:eq, [Jido.Flow.Ref.input(:status), :ready]),
    action: MyApp.HandleReady
  )

Jido.Flow.Choice.new!(
  name: "route",
  options: [option],
  fallback: Jido.Flow.Choice.Fallback.new!(action: MyApp.HandleOther)
)

Summary

Functions

Builds and validates one canonical Choice.

Builds one canonical Choice or raises its validation error.

Types

t()

@type t() :: %Jido.Flow.Choice{
  fallback: any(),
  meta: map(),
  name: binary(),
  needs: [binary()],
  options: [any()]
}

Functions

new(choice)

@spec new(t() | map() | keyword()) :: {:ok, t()} | {:error, Exception.t()}

Builds and validates one canonical Choice.

new!(attrs)

@spec new!(t() | map() | keyword()) :: t() | no_return()

Builds one canonical Choice or raises its validation error.