Arke.System (Arke v0.1.3)

Link to this section Summary

Functions

Macro to create an arke struct with the given parameters. Usable only via code and not iex.

Macro used to define parameter in an arke. See example above arke/2

Macro used to define parameter in an arke. See example above arke/2

Link to this section Functions

Link to this macro

arke(opts \\ [], list)

(macro)
@spec arke(args :: list(), Macro.t()) :: %{}

Macro to create an arke struct with the given parameters. Usable only via code and not iex.

example

Example

arke do
  parameter :custom_parameter, :string, required: true, unique: true
  parameter :custom_parameter2, :string, required: true, values: ["value1", "value2"]
  parameter :custom_parameter3, :integer, required: true, values: [%{label: "option 1", value: 1},%{label: "option 2", value: 2}]
  parameter :custom_parameter4, :dict, required: true, default: %{"default_dict_key": "default_dict_value"}
end

return

Return

%Arke.Core.'{arke_struct}'{}
Link to this macro

group(id, opts \\ [])

(macro)
@spec group(id :: atom(), opts :: list()) :: Macro.t()

Macro used to define parameter in an arke. See example above arke/2

Link to this macro

parameter(id, type, opts \\ [])

(macro)
@spec parameter(id :: atom(), type :: atom(), opts :: list()) :: Macro.t()

Macro used to define parameter in an arke. See example above arke/2