Indexed

View Source Indexed.Helpers (Indexed v0.3.4)

Helper functions for internal use.

Link to this section Summary

Functions

add_to_lookup(lookup, record, field, id)

Given a lookup map, add field according to record.

id(map)

Get the id of the record being operated on from an action state.

id(record, id_key)

Get the id of the record being operated on.

normalize_order_hint(hint)

Convert a field-only order hint into a tuple one.

rm_from_lookup(lookup, record, field, id)

Given a lookup map, remove field according to record.

Link to this section Functions

Link to this function

add_to_lookup(lookup, record, field, id)

View Source 
@spec add_to_lookup(Indexed.lookup(), Indexed.record(), atom(), Indexed.id()) ::
  Indexed.lookup()

Given a lookup map, add field according to record.

Link to this function

id(map)

View Source 
@spec id(map()) :: any()

Get the id of the record being operated on from an action state.

See id_value/2.

Link to this function

id(record, id_key)

View Source 
@spec id(map(), any()) :: any()

Get the id of the record being operated on.

See Indexed.Entity.t/0.

Link to this function

normalize_order_hint(hint)

View Source 
@spec normalize_order_hint(Indexed.order_hint()) :: [{:asc | :desc, atom()}]

Convert a field-only order hint into a tuple one.

Link to this function

rm_from_lookup(lookup, record, field, id)

View Source

Given a lookup map, remove field according to record.