Euclid

View Source Euclid.Duration (Euclid v0.4.0)

A duration is a {time, unit} tuple, where the time is a number and the unit is one of: :nanosecond, :microsecond, :millisecond, :second, :minute, :hour, :day

Link to this section Summary

Types

duration()
time_unit()

Functions

convert(duration, to_unit)

Converts a {duration, time_unit} tuple into a numeric duration. Rounds down to the nearest whole number. Uses System.convert_time_unit/3 under the hood; see its documentation for more details.

to_string(arg)

Converts a {duration, time_unit} tuple into a string.

Link to this section Types

Link to this type

duration()

View Source

Specs

duration() :: {time :: number(), unit :: time_unit()}
Link to this type

time_unit()

View Source

Specs

time_unit() ::
  :nanosecond | :microsecond | :millisecond | :second | :minute | :hour | :day

Link to this section Functions

Link to this function

convert(duration, to_unit)

View Source

Specs

convert(from :: duration(), to :: time_unit()) :: number()

Converts a {duration, time_unit} tuple into a numeric duration. Rounds down to the nearest whole number. Uses System.convert_time_unit/3 under the hood; see its documentation for more details.

Examples 

iex> Euclid.Duration.convert({121, :second}, :minute)
2
Link to this function

to_string(arg)

View Source

Specs

to_string({duration :: duration(), unit :: time_unit()}) :: String.t()

Converts a {duration, time_unit} tuple into a string.

Examples 

iex> Euclid.Duration.to_string({1, :second})
"1 second"

iex> Euclid.Duration.to_string({25, :millisecond})
"25 milliseconds"