Timeanator v1.0.0 Timeanator View Source

This module provides a friendly API for getting time represented in milliseconds.

  import Timeanator
  1 |> minute #=> 60000
  30 |> Timeanator.minutes #=> 1800000

additionally, when methods from_now or ago are used erlang time tuples are provided

import Timeanator
15 |> minutes |> ago #=> {:ok, {{2019, 11, 4}, {1, 24, 14}}}
15 |> minutes |> from_now #=> {:ok, {{2019, 11, 4}, {1, 54, 24}}}

from_now and ago can return Ecto.DateTime structs. This is done by providing the :ecto atom to either the from_now or ago functions

import Timeanator
15 |> minutes |> ago(:ecto) #=> {:ok, #Ecto.DateTime<2019-11-04 01:24:37>}
15 |> minutes |> from_now(:ecto) #=> {:ok, #Ecto.DateTime<2019-11-04 01:54:38>}

Lastly, there are from_now! and ago! variants that raise either Timeanator.Cast or Timeanator.UnsupportedCastingOption exceptions. They also do not return a {:ok, value} tuple, but instead just return value

Link to this section Summary

Functions

ago(milliseconds, cast_option \\ nil)

returns a erlang date that is X milliseconds in the past.

ago!(milliseconds, cast_option \\ nil)

returns a erlang date that is X milliseconds in the past. Raises if there is a problem

day(int)

returns one day in milliseconds

days(int)

returns the amount provided in milliseconds

from_now(milliseconds, cast_option \\ nil)

returns a erlang date that is X milliseconds in the future.

from_now!(milliseconds, cast_options \\ nil)

returns a erlang date that is X milliseconds in the future. Raises if there is a problem

hour(int)

returns one hour in milliseconds

hours(int)

returns the amount provided in milliseconds

millisecond(int)

returns the amount provided in milliseconds

milliseconds(int)

returns the amount provided in milliseconds

minute(int)

returns one minute in milliseconds

minutes(int)

returns the amount provided in milliseconds

second(int)

returns one second in milliseconds

seconds(int)

returns the amount of seconds provided in milliseconds

Link to this section Functions

ago(milliseconds, cast_option \\ nil)

ago(integer(), :ecto | nil) ::
  {:ok, :calendar.datetime()}
  | {:ok,
     %Ecto.DateTime{
       day: term(),
       hour: term(),
       min: term(),
       month: term(),
       sec: term(),
       usec: term(),
       year: term()
     }}
  | {:error, atom()}

returns a erlang date that is X milliseconds in the past.

ago!(milliseconds, cast_option \\ nil)

ago!(integer(), :ecto | nil) ::
  :calendar.datetime()
  | %Ecto.DateTime{
      day: term(),
      hour: term(),
      min: term(),
      month: term(),
      sec: term(),
      usec: term(),
      year: term()
    }

returns a erlang date that is X milliseconds in the past. Raises if there is a problem

day(int)

day(integer()) :: integer()

returns one day in milliseconds

days(int)

days(integer()) :: integer()

returns the amount provided in milliseconds

from_now(milliseconds, cast_option \\ nil)

from_now(integer(), :ecto | nil) ::
  {:ok, :calendar.datetime()}
  | {:ok,
     %Ecto.DateTime{
       day: term(),
       hour: term(),
       min: term(),
       month: term(),
       sec: term(),
       usec: term(),
       year: term()
     }}
  | {:error, atom()}

from_now(integer(), :ecto | nil) ::
  :calendar.datetime()
  | %Ecto.DateTime{
      day: term(),
      hour: term(),
      min: term(),
      month: term(),
      sec: term(),
      usec: term(),
      year: term()
    }

returns a erlang date that is X milliseconds in the future.

from_now!(milliseconds, cast_options \\ nil)

returns a erlang date that is X milliseconds in the future. Raises if there is a problem

hour(int)

hour(integer()) :: integer()

returns one hour in milliseconds

hours(int)

hours(integer()) :: integer()

returns the amount provided in milliseconds

millisecond(int)

millisecond(integer()) :: integer()

returns the amount provided in milliseconds

milliseconds(int)

milliseconds(integer()) :: integer()

returns the amount provided in milliseconds

minute(int)

minute(integer()) :: integer()

returns one minute in milliseconds

minutes(int)

minutes(integer()) :: integer()

returns the amount provided in milliseconds

second(int)

second(integer()) :: integer()

returns one second in milliseconds

seconds(int)

seconds(integer()) :: integer()

returns the amount of seconds provided in milliseconds