AshDefaultSort.Info (ash_default_sort v0.2.0)

View Source

Summary

Functions

List of read actions to exclude

List of read actions to exclude

The sort to apply when a has_many relationship has no sort

The sort to apply when a has_many relationship has no sort

Whether to apply to the primary read action as well

default_sort DSL options

The sort to apply when Ash.Query has no sort

The sort to apply when Ash.Query has no sort

Functions

default_sort_except(dsl_or_extended)

@spec default_sort_except(dsl_or_extended :: module() | map()) ::
  {:ok, [atom()]} | :error

List of read actions to exclude

default_sort_except!(dsl_or_extended)

@spec default_sort_except!(dsl_or_extended :: module() | map()) ::
  [atom()] | no_return()

List of read actions to exclude

default_sort_has_many_sort(dsl_or_extended)

@spec default_sort_has_many_sort(dsl_or_extended :: module() | map()) ::
  {:ok, keyword()} | :error

The sort to apply when a has_many relationship has no sort

default_sort_has_many_sort!(dsl_or_extended)

@spec default_sort_has_many_sort!(dsl_or_extended :: module() | map()) ::
  keyword() | no_return()

The sort to apply when a has_many relationship has no sort

default_sort_include_primary_read?(dsl_or_extended)

@spec default_sort_include_primary_read?(dsl_or_extended :: module() | map()) ::
  boolean()

Whether to apply to the primary read action as well

default_sort_options(dsl_or_extended)

@spec default_sort_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

default_sort DSL options

Returns a map containing the and any configured or default values.

default_sort_sort(dsl_or_extended)

@spec default_sort_sort(dsl_or_extended :: module() | map()) ::
  {:ok, keyword()} | :error

The sort to apply when Ash.Query has no sort

default_sort_sort!(dsl_or_extended)

@spec default_sort_sort!(dsl_or_extended :: module() | map()) ::
  keyword() | no_return()

The sort to apply when Ash.Query has no sort