FatEcto.Pagination.Helper (FatEcto v1.3.0)

Provides utility functions for FatEcto, including handling pagination limits, skip values, dynamic binding, and preloading associations.

Summary

Returns the maximum and default limit values based on the provided options.

Extracts and validates the limit value from the given parameters.

Extracts and validates the skip value from the given parameters.

@spec get_limit_bounds(nil | keyword() | map()) :: {integer(), integer()}

Returns the maximum and default limit values based on the provided options.

iex> FatEcto.Pagination.Helper.get_limit_bounds(max_limit: 50, default_limit: 10)
{50, 10}

@spec get_limit_value(
  keyword(),
  nil | keyword() | map()
) :: {integer(), keyword()}

Extracts and validates the limit value from the given parameters.

iex> FatEcto.Pagination.Helper.get_limit_value([limit: 15], max_limit: 50, default_limit: 10)
{15, []}

@spec get_skip_value(keyword()) :: {integer(), keyword()}

Extracts and validates the skip value from the given parameters.

iex> FatEcto.Pagination.Helper.get_skip_value(skip: 20)
{20, []}