View Source Timex.Types (timex v3.7.11)

Link to this section Summary

Link to this section Types

@type calendar_types() :: Date.t() | DateTime.t() | NaiveDateTime.t() | Time.t()
@type date() :: {year(), month(), day()}
@type datetime() :: {date(), time()}
@type day() :: Calendar.day()
@type daynum() :: 1..366
@type hour() :: Calendar.hour()
@type iso_triplet() :: {year(), weeknum(), weekday()}
@type megaseconds() :: non_neg_integer()
@type microsecond() :: Calendar.microsecond()
Link to this type

microsecond_datetime()

View Source
@type microsecond_datetime() :: {date(), microsecond_time()}
@type microsecond_time() ::
  {hour(), minute(), second(), microsecond() | microseconds()}
@type microseconds() :: non_neg_integer()
@type minute() :: Calendar.minute()
@type month() :: Calendar.month()
@type num_of_days() :: 28..31
@type second() :: Calendar.second()
@type seconds() :: non_neg_integer()
@type shift_units() ::
  :milliseconds | :seconds | :minutes | :hours | :days | :weeks | :years
@type std_offset() :: Calendar.std_offset()
@type time() :: {hour(), minute(), second()}
@type time_units() ::
  :microsecond
  | :microseconds
  | :millisecond
  | :milliseconds
  | :second
  | :seconds
  | :minute
  | :minutes
  | :hour
  | :hours
  | :day
  | :days
  | :week
  | :weeks
  | :year
  | :years
@type time_zone() :: Calendar.time_zone()
@type timestamp() :: {megaseconds(), seconds(), microseconds()}
@type tz_offset() :: -14..12
@type utc_offset() :: Calendar.utc_offset()
@type valid_date() :: Date.t() | date()
@type valid_datetime() ::
  Date.t()
  | DateTime.t()
  | NaiveDateTime.t()
  | Time.t()
  | datetime()
  | date()
  | microsecond_datetime()
@type valid_time() :: Time.t() | time()
@type valid_timezone() :: String.t() | tz_offset() | :utc | :local
@type week_of_month() :: 1..6
@type weekday() :: 1..7
@type weekday_name() ::
  :monday | :tuesday | :wednesday | :thursday | :friday | :saturday | :sunday
@type weeknum() :: 1..53
@type weekstart() :: weekday() | binary() | atom()
@type year() :: Calendar.year()
@type zone_abbr() :: Calendar.zone_abbr()