Timex.Types (timex v3.7.13)

View Source

Summary

Types

calendar_types()

@type calendar_types() :: Date.t() | DateTime.t() | NaiveDateTime.t() | Time.t()

date()

@type date() :: {year(), month(), day()}

datetime()

@type datetime() :: {date(), time()}

day()

@type day() :: Calendar.day()

daynum()

@type daynum() :: 1..366

hour()

@type hour() :: Calendar.hour()

iso_triplet()

@type iso_triplet() :: {year(), weeknum(), weekday()}

megaseconds()

@type megaseconds() :: non_neg_integer()

microsecond()

@type microsecond() :: Calendar.microsecond()

microsecond_datetime()

@type microsecond_datetime() :: {date(), microsecond_time()}

microsecond_time()

@type microsecond_time() ::
  {hour(), minute(), second(), microsecond() | microseconds()}

microseconds()

@type microseconds() :: non_neg_integer()

minute()

@type minute() :: Calendar.minute()

month()

@type month() :: Calendar.month()

num_of_days()

@type num_of_days() :: 28..31

second()

@type second() :: Calendar.second()

seconds()

@type seconds() :: non_neg_integer()

shift_units()

@type shift_units() ::
  :milliseconds | :seconds | :minutes | :hours | :days | :weeks | :years

std_offset()

@type std_offset() :: Calendar.std_offset()

time()

@type time() :: {hour(), minute(), second()}

time_units()

@type time_units() ::
  :microsecond
  | :microseconds
  | :millisecond
  | :milliseconds
  | :second
  | :seconds
  | :minute
  | :minutes
  | :hour
  | :hours
  | :day
  | :days
  | :week
  | :weeks
  | :year
  | :years

time_zone()

@type time_zone() :: Calendar.time_zone()

timestamp()

@type timestamp() :: {megaseconds(), seconds(), microseconds()}

tz_offset()

@type tz_offset() :: -14..12

utc_offset()

@type utc_offset() :: Calendar.utc_offset()

valid_date()

@type valid_date() :: Date.t() | date()

valid_datetime()

@type valid_datetime() ::
  Date.t()
  | DateTime.t()
  | NaiveDateTime.t()
  | Time.t()
  | datetime()
  | date()
  | microsecond_datetime()

valid_time()

@type valid_time() :: Time.t() | time()

valid_timezone()

@type valid_timezone() :: String.t() | tz_offset() | :utc | :local

week_of_month()

@type week_of_month() :: 1..6

weekday()

@type weekday() :: 1..7

weekday_name()

@type weekday_name() ::
  :monday | :tuesday | :wednesday | :thursday | :friday | :saturday | :sunday

weeknum()

@type weeknum() :: 1..53

weekstart()

@type weekstart() :: weekday() | binary() | atom()

year()

@type year() :: Calendar.year()

zone_abbr()

@type zone_abbr() :: Calendar.zone_abbr()