antl_utils_elixir v1.4.5

AntlUtilsElixir.DateTime.Period (antl_utils_elixir v1.4.5)

Period

Link to this section Summary

Types

t()

Functions

filter_by_status(periods, status, datetime, start_key \\ :start_at, end_key \\ :end_at)
get_status(map, datetime)
get_status(period, datetime, start_at_key, end_at_key)
included?(a, b)
included?(a, b, start_at_key, end_at_key)

Link to this section Types

Link to this type

t()

Specs

t() ::
  %{start_at: nil | DateTime.t(), end_at: nil | DateTime.t()}
  | %{struct: atom(), start_at: nil | DateTime.t(), end_at: nil | DateTime.t()}

Link to this section Functions

Link to this function

filter_by_status(periods, status, datetime, start_key \\ :start_at, end_key \\ :end_at)

Specs

filter_by_status([t()], atom() | [atom()], DateTime.t(), atom(), atom()) :: [
  any()
]
Link to this function

get_status(map, datetime)

Specs

get_status(t(), DateTime.t()) :: :ended | :ongoing | :scheduled
Link to this function

get_status(period, datetime, start_at_key, end_at_key)

Specs

get_status(map(), DateTime.t(), atom(), atom()) ::
  :ended | :ongoing | :scheduled
Link to this function

included?(a, b)

Specs

included?(t(), t()) :: boolean()
Link to this function

included?(a, b, start_at_key, end_at_key)

Specs

included?(map(), map(), atom(), atom()) :: boolean()