chore_runner v0.5.0

ChoreRunner.Input (chore_runner v0.5.0)

Link to this section Summary

Types

input_options()
input_type()
reason()
t()
validator_function()

Functions

bool(name, opts \\ [])
file(name, opts \\ [])
float(name, opts \\ [])
int(name, opts \\ [])
string(name, opts \\ [])
types()
valid_type(type)
validate_field(type, value)

Link to this section Types

Link to this type

input_options()

Specs

input_options() :: [validators: [validator_function()], description: String.t()]
Link to this type

input_type()

Specs

input_type() :: :string | :int | :float | :file | :bool
Link to this type

reason()

Specs

reason() :: atom() | String.t()
Link to this type

t()

Specs

t() :: {input_type(), atom(), input_options()}
Link to this type

validator_function()

Specs

validator_function() ::
  (term() -> {:ok, term()} | :ok | true | {:error, reason()} | nil | false)

Link to this section Functions

Link to this function

bool(name, opts \\ [])

Specs

bool(atom(), input_options()) :: t()
Link to this function

file(name, opts \\ [])

Specs

file(atom(), input_options()) :: t()
Link to this function

float(name, opts \\ [])

Specs

float(atom(), input_options()) :: t()
Link to this function

int(name, opts \\ [])

Specs

int(atom(), input_options()) :: t()
Link to this function

string(name, opts \\ [])

Specs

string(atom(), input_options()) :: t()
Link to this function

types()

Link to this macro

valid_type(type)

(macro)
Link to this function

validate_field(type, value)