Azan.TimeComponent (AzanEx v0.3.0)

Documentation for TimeComponent.

Summary

t()

Create a DateTime from TimeComponent

new(num)

Create a new TimeComponent from an hour with fractional part.

Convert a TimeComponent to a string in the format of "HH:MM".

@type t() :: %Azan.TimeComponent{
  hour: integer() | nil,
  minute: integer() | nil,
  second: integer() | nil
}

Create a DateTime from TimeComponent

 ## Examples

  iex> TimeComponent.new(12.5) |> TimeComponent.create_utc_datetime(2015, 1, 1)
  ~U[2015-01-01 12:30:00Z]

Create a new TimeComponent from an hour with fractional part.

 ## Examples

  iex> TimeComponent.new(12.5)
  %TimeComponent{hour: 12, minute: 30, second: 0}

Convert a TimeComponent to a string in the format of "HH:MM".

 ## Examples

  iex> TimeComponent.new(12.5) |> TimeComponent.to_hm_string()
  "12:30"