Ash.Type.Tuple (ash v3.5.24)
View SourceRepresents a tuple stored in the data layer as a map.
A builtin type that can be referenced via :tuple
:fields
(keyword/0
) - Required. The types of the fields in the tuple, and their constraints.
This type is stored as a map under the hood, keyed by the field name, and is represented in memory as a tuple.
Example constraints:constraints: fields: [ amount: [ type: :integer, description: "The amount of the transaction", constraints: [ max: 10 ] ], currency: [ type: :string, allow_nil?: false, description: "The currency code of the transaction", constraints: [ max_length: 3 ] ] ]
allow_nil?
istrue
by default.:type
(anAsh.Type
) - Required.:allow_nil?
(boolean/0
) - The default value istrue
.:description
(String.t/0
):constraints
(keyword/0
) - The default value is[]
.