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

View Source

A portable reference in a canonical Flow expression.

Summary

Functions

Builds a Reduce accumulator reference.

Builds an Iterate body result reference.

Builds a runtime context reference.

Builds a Flow input reference with a required path.

Builds a Map or Reduce item reference.

Builds a collection item identifier reference.

Builds a collection item index reference.

Builds an Iterate index reference.

Builds a named component result reference.

Appends a path to a reference after validating its source.

Builds an Iterate state reference.

Types

path()

@type path() :: [atom() | String.t() | non_neg_integer()]

scope()

@type scope() ::
  :any
  | :flow
  | :map_collection
  | :map_params
  | :reduce_collection
  | :reduce_initial
  | :reduce_params
  | :iterate_initial
  | :iterate_params
  | :iterate_update
  | :iterate_completion

source()

@type source() ::
  :input
  | :context
  | :result
  | :item
  | :item_index
  | :item_id
  | :accumulator
  | :state
  | :iteration_index
  | :body_result

t()

@type t() :: %Jido.Flow.Ref{
  component: nil | binary(),
  path: [any()],
  source:
    :input
    | :context
    | :result
    | :item
    | :item_index
    | :item_id
    | :accumulator
    | :state
    | :iteration_index
    | :body_result
}

Functions

accumulator(path \\ nil)

@spec accumulator(term()) :: t()

Builds a Reduce accumulator reference.

body_result(path \\ nil)

@spec body_result(term()) :: t()

Builds an Iterate body result reference.

context(path \\ nil)

@spec context(term()) :: t()

Builds a runtime context reference.

input(path)

@spec input(term()) :: t()

Builds a Flow input reference with a required path.

item(path \\ nil)

@spec item(term()) :: t()

Builds a Map or Reduce item reference.

item_id()

@spec item_id() :: t()

Builds a collection item identifier reference.

item_index()

@spec item_index() :: t()

Builds a collection item index reference.

iteration_index()

@spec iteration_index() :: t()

Builds an Iterate index reference.

result(component, path \\ nil)

@spec result(atom() | String.t(), term()) :: t()

Builds a named component result reference.

select(source, path)

@spec select(t(), term()) :: t() | no_return()

Appends a path to a reference after validating its source.

state(path \\ nil)

@spec state(term()) :: t()

Builds an Iterate state reference.