Current section

Files

Jump to
quantum lib quantum date_library.ex
Raw

lib/quantum/date_library.ex

defmodule Quantum.DateLibrary do
@moduledoc """
This Behaviour offers Date Library Independant integration of helper
functions.
**This behaviour is considered internal. Breaking Changes can occur on every
release.**
Make sure your implementation passes `Quantum.DateLibraryTest`. Otherwise
unexpected behaviour can occur.
"""
@doc """
Convert `NaiveDateTime` in UTC to `NaiveDateTime` in given tz.
"""
@callback utc_to_tz(NaiveDateTime.t, String.t) :: NaiveDateTime.t | no_return
@doc """
Gives back the required application dependency to start, if any is needed.
"""
@callback dependency_application :: atom | nil
end