Ash.Query.Function behaviour (ash v1.46.8) View Source

A function is a predicate with an arguments list.

For more information on being a predicate, see Ash.Filter.Predicate. Most of the complexities are there. A function must meet both behaviours.

Link to this section Summary

arg()

Attaches the appropiate suffix to refer to an ordinal number, e.g 1 -> "1st"

args()

The number and types of arguments supported.

arg() :: any()

Attaches the appropiate suffix to refer to an ordinal number, e.g 1 -> "1st"

args() :: [arg()]

The number and types of arguments supported.

evaluate(func :: map()) :: :unknown | {:known, term()}

new([term()]) :: {:ok, term()}