DataProvider v1.2.1

DataProvider.Sort (DataProvider v1.2.1) View Source

Module with sorting params for DataProvider

Link to this section Summary

Types

t()

Sort options

Functions

create(options \\ [])

Creates new DataProvider.Sort with received params

merge_options(sort, params)

Merges options value of received DataProvider.Sort with params in second argument.

put_options(sort, params)

Replaces options in DataProvider.Sort by received params map.

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %DataProvider.Sort{options: map()}

Sort options

Fields

  • options - Keyword with data searching options for DataProvider

Link to this section Functions

Link to this function

create(options \\ [])

View Source

Specs

create(Keyword.t()) :: t()

Creates new DataProvider.Sort with received params

Link to this function

merge_options(sort, params)

View Source

Specs

merge_options(t(), Keyword.t()) :: t()

Merges options value of received DataProvider.Sort with params in second argument.

Args

Link to this function

put_options(sort, params)

View Source

Specs

put_options(t(), Keyword.t()) :: t()

Replaces options in DataProvider.Sort by received params map.

Args

  • sort - DataProvider.Sort which need to replace

  • param - Keyword with new options for replacing