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

View Source

A named child Flow module in a canonical Flow.

Summary

Functions

Builds and validates one canonical Subflow component.

Builds one canonical Subflow or raises its validation error.

Types

t()

@type t() :: %Jido.Flow.Subflow{
  flow: atom(),
  meta: map(),
  name: binary(),
  needs: [binary()],
  params: any()
}

Functions

new(subflow)

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

Builds and validates one canonical Subflow component.

new!(attrs)

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

Builds one canonical Subflow or raises its validation error.