View Source Reactor.Argument (reactor v0.8.1)

A step argument.

Summary

Types

t()

Functions

from_input(name, input_name, transform \\ nil)

Build an argument which refers to a reactor input with an optional transformation applied.

from_result(name, result_name, transform \\ nil)

Build an argument which refers to the result of another step with an optional transformation applied.

from_value(name, value, transform \\ nil)

Build an argument which refers to a statically defined value.

has_sub_path(argument)

Validate that the argument source has a sub_path

has_transform(argument)

Validate that the argument has a transform.

is_argument(argument)

Validate that the argument is an Argument struct.

is_from_input(argument)

Validate that the argument refers to a reactor input.

is_from_result(argument)

Validate that the argument refers to a step result.

is_from_value(argument)

Validate that the argument contains a static value.

Types

Link to this type

t()

View Source 
@type t() :: %Reactor.Argument{
  name: atom(),
  source: Reactor.Template.t(),
  transform: nil | (any() -> any()) | {module(), keyword()} | mfa()
}

Functions

Link to this function

from_input(name, input_name, transform \\ nil)

View Source 
@spec from_input(atom(), atom(), nil | (any() -> any())) :: t()

Build an argument which refers to a reactor input with an optional transformation applied.

Example 

iex> Argument.from_input(:argument_name, :input_name, &String.to_integer/1)
Link to this function

from_result(name, result_name, transform \\ nil)

View Source 
@spec from_result(atom(), any(), nil | (any() -> any())) :: t()

Build an argument which refers to the result of another step with an optional transformation applied.

Example 

iex> Argument.from_result(:argument_name, :step_name, &Atom.to_string/1)
Link to this function

from_value(name, value, transform \\ nil)

View Source 
@spec from_value(atom(), any(), nil | (any() -> any())) :: t()

Build an argument which refers to a statically defined value.

Example 

iex> Argument.from_value(:argument_name, 10)
Link to this macro

has_sub_path(argument)

View Source (macro)

Validate that the argument source has a sub_path

Link to this macro

has_transform(argument)

View Source (macro)

Validate that the argument has a transform.

Link to this macro

is_argument(argument)

View Source (macro)

Validate that the argument is an Argument struct.

Link to this macro

is_from_input(argument)

View Source (macro)

Validate that the argument refers to a reactor input.

Link to this macro

is_from_result(argument)

View Source (macro)

Validate that the argument refers to a step result.

Link to this macro

is_from_value(argument)

View Source (macro)

Validate that the argument contains a static value.