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

View Source

A named Flow fan-out operation over one ordered collection.

A Map is one canonical authoring component. Native execution exposes its Runic FanOut, item, FanIn, and output work. Create it with new/1, the Flow module DSL, map-based definitions, or Jido.Flow.Codec.

Summary

Functions

Builds and validates one canonical Map component.

Builds one canonical Map component or raises its validation error.

Types

error_mode()

@type error_mode() :: :fail_fast | :collect_errors

t()

@type t() :: %Jido.Flow.Map{
  action: atom(),
  collection: any(),
  meta: map(),
  name: binary(),
  needs: [binary()],
  on_error: :fail_fast | :collect_errors,
  params: any()
}

Functions

new(map)

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

Builds and validates one canonical Map component.

new!(attrs)

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

Builds one canonical Map component or raises its validation error.