Data.DateTime.Instant

newtype Instant

An instant is a duration in milliseconds relative to the Unix epoch (1970-01-01 00:00:00 UTC).

The constructor is private as the Instant range matches that of the DateTime type.

Instances

• Eq Instant
• Ord Instant
• Bounded Instant
• Show Instant

instant :: Milliseconds -> Maybe Instant

Attempts to create an Instant from a Milliseconds duration. The minimum acceptable value equates to the bottom DateTime and the maximum acceptable value equates to the top DateTime.

unInstant :: Instant -> Milliseconds

Lowers an Instant to a Milliseconds duration.

fromDateTime :: DateTime -> Instant

Creates an Instant from a DateTime value.

fromDate :: Date -> Instant

Creates an Instant from a Date value, using the assumed time 00:00:00.

toDateTime :: Instant -> DateTime

Creates a DateTime value from an Instant.

diff :: forall d. Duration d => Instant -> Instant -> d

Calculates the difference between two instants, returning the result as a duration. For example:

do
  start <- liftEffect Now.now
  aLongRunningAff
  end <- liftEffect Now.now
  let
    hours :: Duration.Hours
    hours = Instant.diff end start
  log ("A long running Aff took " <> show hours)