View Source Nebulex.Time (Nebulex v2.6.1)

Time utilities.

Summary

Functions

now(unit \\ :millisecond)

Returns the current system time in the given time unit.

timeout?(timeout)

Returns true if the given timeout is a valid timeout; otherwise, false is returned.

Functions

Link to this function

now(unit \\ :millisecond)

View Source 
@spec now(System.time_unit()) :: integer()

Returns the current system time in the given time unit.

The unit is set to :millisecond by default.

Examples 

iex> now = Nebulex.Time.now()
iex> is_integer(now) and now > 0
true
Link to this function

timeout?(timeout)

View Source 
@spec timeout?(term()) :: boolean()

Returns true if the given timeout is a valid timeout; otherwise, false is returned.

Valid timeout: :infinity | non_neg_integer().

Examples 

iex> Nebulex.Time.timeout?(1)
true

iex> Nebulex.Time.timeout?(:infinity)
true

iex> Nebulex.Time.timeout?(-1)
false

iex> Nebulex.Time.timeout?(1.1)
false