Duration

Core

Elapsed time as an opaque millisecond count.

Combine with Time.Posix via add, sub, and between.

Types

Duration

type Duration = Duration Int

A length of time, stored as whole milliseconds.

Examples

seconds 1 : Duration

Values

fromMillis

fromMillis : Int -> Duration

Build a duration from a millisecond count (may be negative).

Examples

toMillis (fromMillis 500) == 500

toMillis

toMillis : Duration -> Int

Milliseconds in this duration.

Examples

toMillis (seconds 2) == 2000

zero

zero : Duration

A zero-length duration.

Examples

toMillis zero == 0

milliseconds

milliseconds : Int -> Duration

n milliseconds.

Examples

toMillis (milliseconds 250) == 250

seconds

seconds : Int -> Duration

n seconds.

Examples

toMillis (seconds 1) == 1000

minutes

minutes : Int -> Duration

n minutes.

Examples

toMillis (minutes 1) == 60000

hours

hours : Int -> Duration

n hours.

Examples

toMillis (hours 1) == 3600000

days

days : Int -> Duration

n 24-hour days (no calendar awareness).

Examples

toMillis (days 1) == 86400000

add

add : Duration -> Posix -> Posix

Move a posix instant forward by this duration.

Examples

Time.posixToMillis (add (seconds 1) (Time.millisToPosix 0)) == 1000

sub

sub : Duration -> Posix -> Posix

Move a posix instant backward by this duration.

Examples

Time.posixToMillis (sub (seconds 1) (Time.millisToPosix 1000)) == 0

between

between : Posix -> Posix -> Duration

Duration from a to b (b - a in milliseconds).

Examples

toMillis (between (Time.millisToPosix 0) (Time.millisToPosix 1000)) == 1000

compare

compare : Duration -> Duration -> Order

Compare two durations by millisecond length.

Examples

compare (seconds 1) (milliseconds 1000) == EQ
compare (seconds 1) (seconds 2) == LT