Skip to content
Docs
Modules
time

time

Module time provides functionality for measuring and displaying time.

This is primarily a wrapper of the Go time (opens in a new tab) package, with the one difference being duration values are represented as float values (in seconds) instead of a dedicated duration type.

Constants

Predefined layouts for use in time.parse and time.format include:

  • ANSIC
  • UnixDate
  • RubyDate
  • RFC822
  • RFC822Z
  • RFC850
  • RFC1123
  • RFC1123Z
  • RFC3339
  • RFC3339Nano
  • Kitchen
  • Stamp
  • StampMilli
  • StampMicro
  • StampNano

Example Constant Usage

Example
>>> time.parse(time.RFC3339, "2023-08-01T12:00:00-04:00")
time("2023-08-01T12:00:00-04:00")

Functions

now

Function signature
now() time

Returns the current time as a time object.

Example
>>> time.now()
time("2024-01-15T12:51:10-05:00")

parse

Function signature
parse(layout, value string) time

Parses a string into a time.

Example
>>> time.parse(time.RFC3339, "2023-08-07T21:19:27-04:00")
time("2023-08-07T21:19:27-04:00")

since

Function signature
since(t time) float

Returns the elapsed time in seconds since the given time.

Example
>>> t := time.now()
>>> time.since(t)
1.864104666

sleep

Function signature
sleep(duration float)

Sleeps for the given duration in seconds.

Example
>>> time.sleep(1)

Types

time

The time type represents a moment in time.

Methods

time.before
Method signature
before(t time) bool

Returns whether this time is before the given time.

Example
>>> t := time.parse(time.RFC3339, "2023-08-01T12:00:00-04:00")
>>> t.before(time.parse(time.RFC3339, "2023-08-02T00:00:00-04:00"))
true
time.after
Method signature
after(t time) bool

Returns whether this time is after the given time.

Example
>>> t := time.parse(time.RFC3339, "2023-08-01T12:00:00-04:00")
>>> t.after(time.parse(time.RFC3339, "2023-08-02T00:00:00-04:00"))
false
time.format
Method signature
format(layout string) string

Formats the time according to the given layout.

Example
>>> t := time.parse(time.RFC3339, "2023-08-01T12:00:00-04:00")
>>> t.format(time.RFC3339)
"2023-08-01T12:00:00-04:00"
>>> t.format(time.Kitchen)
"12:00PM"
>>> t.format(time.UnixDate)
"Tue Aug  1 12:00:00 EDT 2023"
time.utc
Method signature
utc() time

Returns the UTC time corresponding to this time.

Example
>>> t := time.parse(time.RFC3339, "2023-08-01T12:00:00-04:00")
>>> t.utc()
time("2023-08-01T16:00:00Z")
time.unix
Method signature
unix() int

Returns the number of seconds elapsed since the Unix epoch.

Example
>>> t := time.parse(time.RFC3339, "2023-08-01T12:00:00-04:00")
>>> t.unix()
1690905600