luminous v1.3.0

View Source Luminous.TimeRange (luminous v1.3.0)

This module defines a struct with two fields (:from and :to) to represent a time range. Additionally, various helper functions are defined that operate on time ranges.

Link to this section Summary

Types

t()

Functions

add(dt, n, atom)
from_iso(from_iso, to_iso)
from_unix(from_unix, to_unix)
last_month(tz, now \\ nil)
last_n_days(n, tz, now \\ nil)
last_week(tz, now \\ nil)
new(from, to)
round(dt, atom)
shift_zone!(time_range, time_zone)
this_month(tz, now \\ nil)
this_week(tz, now \\ nil)
to_map(time_range)
today(tz, now \\ nil)
tomorrow(tz, now \\ nil)
yesterday(tz, now \\ nil)

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Luminous.TimeRange{from: DateTime.t(), to: DateTime.t()}

Link to this section Functions

Link to this function

add(dt, n, atom)

View Source 
@spec add(DateTime.t(), integer(), atom()) :: DateTime.t()
Link to this function

from_iso(from_iso, to_iso)

View Source 
@spec from_iso(binary(), binary()) :: t()
Link to this function

from_unix(from_unix, to_unix)

View Source 
@spec from_unix(non_neg_integer(), non_neg_integer()) :: t()
Link to this function

last_month(tz, now \\ nil)

View Source 
@spec last_month(binary(), DateTime.t() | nil) :: t()
Link to this function

last_n_days(n, tz, now \\ nil)

View Source 
@spec last_n_days(non_neg_integer(), binary(), DateTime.t() | nil) :: t()
Link to this function

last_week(tz, now \\ nil)

View Source 
@spec last_week(binary(), DateTime.t() | nil) :: t()
Link to this function

new(from, to)

View Source 
@spec new(DateTime.t(), DateTime.t()) :: t()
Link to this function

round(dt, atom)

View Source 
@spec round(DateTime.t(), atom()) :: DateTime.t()
Link to this function

shift_zone!(time_range, time_zone)

View Source 
@spec shift_zone!(t(), binary()) :: t()
Link to this function

this_month(tz, now \\ nil)

View Source 
@spec this_month(binary(), DateTime.t() | nil) :: t()
Link to this function

this_week(tz, now \\ nil)

View Source 
@spec this_week(binary(), DateTime.t() | nil) :: t()
Link to this function

to_map(time_range)

View Source 
@spec to_map(t()) :: map()
Link to this function

today(tz, now \\ nil)

View Source 
@spec today(binary(), DateTime.t() | nil) :: t()
Link to this function

tomorrow(tz, now \\ nil)

View Source 
@spec tomorrow(binary(), DateTime.t() | nil) :: t()
Link to this function

yesterday(tz, now \\ nil)

View Source 
@spec yesterday(binary(), DateTime.t() | nil) :: t()