timex

v2.1.5

timex v2.1.5 Timex.Date

This module represents all functions specific to creating/manipulating/comparing Dates (year/month/day)

Summary

Types

t()

Functions

compare(a, b)

See docs for Timex.compare/3

compare(a, b, granularity)

See Timex.Comparable.compare/3

diff(a, b)

See docs for Timex.diff/3

diff(a, b, granularity)

See Timex.Comparable.diff/3

epoch()

Returns a Date representing the date of the UNIX epoch

epoch(atom)
from(date)

Converts from a date/time value to a Date struct representing that date

from(value, type, ref \\ :epoch)

WARNING: This is here to ease the migration to 2.x, but is deprecated

from_days(n, ref \\ :epoch)

Given an integer value representing days since the reference date (:epoch or :zero), returns a Date struct representing that date

from_erl(arg1)

Like from/1, but more explicit about it’s inputs (Erlang date/datetime tuples only)

from_microseconds(n, ref \\ :epoch)

Given an integer value representing microseconds since the reference date (:epoch or :zero), returns a Date struct representing that date

from_millisecond(, )
from_milliseconds(n, ref \\ :epoch)

Given an integer value representing milliseconds since the reference date (:epoch or :zero), returns a Date struct representing that date

from_seconds(n, ref \\ :epoch)

Given an integer value representing seconds since the reference date (:epoch or :zero), returns a Date struct representing that date

from_timestamp(timestamp, ref \\ :epoch)

Given an Erlang timestamp, converts it to a Date struct representing the date of that timestamp

now()

Returns today’s date as a Date struct. If given a timezone, returns whatever “today” is in that timezone

now(tz)
set(date, options)

See docs for Timex.set/2 for details

shift(date, options)

Shifts the given Date based on the provided options. See Timex.shift/2 for more information

to_datetime(dt)

Converts a Date to a DateTime in UTC

to_days(date, ref \\ :epoch)

Convert the date to an integer number of days since Epoch or year 0

to_seconds(date, ref \\ :epoch)

Convert a date to an integer number of seconds since Epoch or year 0

to_secs(date)

See Timex.Date.to_seconds/1

to_secs(date, ref)

See Timex.Date.to_seconds/2

to_timestamp(date, ref \\ :epoch)

Convert a date to a timestamp value consumable by the Time module

today()

Returns today’s date as a Date struct. If given a timezone, returns whatever “today” is in that timezone

today(tz)
zero()

Returns a Date representing the first day of year zero

Types 

t :: %Timex.Date{calendar: term, day: term, month: term, year: term}

Functions

compare(a, b)

See docs for Timex.compare/3

compare(a, b, granularity)

See Timex.Comparable.compare/3.

diff(a, b)

See docs for Timex.diff/3

diff(a, b, granularity)

See Timex.Comparable.diff/3.

epoch()

Specs

epoch :: Timex.DateTime.t

Returns a Date representing the date of the UNIX epoch

epoch(atom)

Specs

epoch(:seconds) :: Timex.DateTime.t
from(date)

Specs

from(Types.valid_datetime | Types.dtz | Types.phoenix_datetime_select_params) ::
  Timex.Date.t |
  {:error, term}

Converts from a date/time value to a Date struct representing that date

from(value, type, ref \\ :epoch)

WARNING: This is here to ease the migration to 2.x, but is deprecated.

Converts a value of the provided type to a Date struct, relative to the reference date (:epoch or :zero)

from_days(n, ref \\ :epoch)

Specs

from_days(non_neg_integer, :epoch | :zero) ::
  Timex.Date.t |
  {:error, term}

Given an integer value representing days since the reference date (:epoch or :zero), returns a Date struct representing that date

from_erl(arg1)

Like from/1, but more explicit about it’s inputs (Erlang date/datetime tuples only).

from_microseconds(n, ref \\ :epoch)

Specs

from_microseconds(non_neg_integer, :epoch | :zero) ::
  Timex.Date.t |
  {:error, term}

Given an integer value representing microseconds since the reference date (:epoch or :zero), returns a Date struct representing that date

from_millisecond(, )
from_milliseconds(n, ref \\ :epoch)

Specs

from_milliseconds(non_neg_integer, :epoch | :zero) ::
  Timex.Date.t |
  {:error, term}

Given an integer value representing milliseconds since the reference date (:epoch or :zero), returns a Date struct representing that date

from_seconds(n, ref \\ :epoch)

Specs

from_seconds(non_neg_integer, :epoch | :zero) ::
  Timex.Date.t |
  {:error, term}

Given an integer value representing seconds since the reference date (:epoch or :zero), returns a Date struct representing that date

from_timestamp(timestamp, ref \\ :epoch)

Specs

from_timestamp(Types.timestamp, :epoch | :zero) ::
  Timex.Date.t |
  {:error, term}

Given an Erlang timestamp, converts it to a Date struct representing the date of that timestamp

now()

Specs

now :: Timex.Date.t | {:error, term}

Returns today’s date as a Date struct. If given a timezone, returns whatever “today” is in that timezone

now(tz)

Specs

now(Types.valid_timezone) ::
  Timex.DateTime.t |
  {:error, term}
set(date, options)

Specs

set(Timex.Date.t, [{atom, term}]) ::
  Timex.Date.t |
  {:error, term}

See docs for Timex.set/2 for details.

shift(date, options)

Specs

shift(Timex.Date.t, [{atom, term}]) ::
  Timex.Date.t |
  {:error, term}

Shifts the given Date based on the provided options. See Timex.shift/2 for more information.

to_datetime(dt)

Specs

to_datetime(Timex.Date.t) ::
  Timex.DateTime.t |
  {:error, term}

Converts a Date to a DateTime in UTC

to_days(date, ref \\ :epoch)

Specs

to_days(Timex.Date.t, :epoch | :zero) ::
  integer |
  {:error, term}

Convert the date to an integer number of days since Epoch or year 0.

See also Timex.diff/3 if you want to specify an arbitray reference date.

Examples

iex> Timex.date({1970, 1, 15}) |> Elixir.Timex.Date.to_days
14
to_seconds(date, ref \\ :epoch)

Specs

to_seconds(Timex.Date.t, :epoch | :zero) ::
  integer |
  {:error, term}

Convert a date to an integer number of seconds since Epoch or year 0.

See also Timex.diff/3 if you want to specify an arbitrary reference date.

Examples

iex> Timex.date({1999, 1, 2}) |> Elixir.Timex.Date.to_seconds
915235200
to_secs(date)

See Timex.Date.to_seconds/1.

to_secs(date, ref)

See Timex.Date.to_seconds/2.

to_timestamp(date, ref \\ :epoch)

Specs

to_timestamp(Timex.Date.t, :epoch | :zero) ::
  Types.timestamp |
  {:error, term}

Convert a date to a timestamp value consumable by the Time module.

See also diff/2 if you want to specify an arbitrary reference date.

Examples

iex> Elixir.Timex.Date.epoch |> Elixir.Timex.Date.to_timestamp {0,0,0}

today()

Specs

today :: Timex.Date.t | {:error, term}

Returns today’s date as a Date struct. If given a timezone, returns whatever “today” is in that timezone

today(tz)

Specs

today(Types.valid_timezone) ::
  Timex.Date.t |
  {:error, term}
zero()

Specs

zero :: Timex.Date.t

Returns a Date representing the first day of year zero