Skip to content

clock.md

Latest commit

 

History

History
74 lines (46 loc) · 1.89 KB

clock.md

File metadata and controls

74 lines (46 loc) · 1.89 KB
Raw

Richy-Z/clock

A lightweight but precise clock utility library for Luvit, with full support for:

  • Nanosecond-precision UNIX time using ffi
  • Millisecond resolution
  • ISO 8601 / RFC 3339 time formatting
  • UTC-safe ISO 8601 string parsing
  • Optional alias: clock.now() is equal to clock.epoch()

 Usage

local clock = require("clock")

clock.epoch()

  • Alias: clock.now()

Returns the current UNIX time in seconds with fractional milliseconds using the OS' native time function via FFI.

local currentTime = clock.epoch()

print(currentTime) -- 1748187427.5988

 clock.milliseconds()

Uses clock.epoch() to give you the current UNIX time in milliseconds. It is a simple wrapper that just multiplies the result of clock.epoch() by 1000.

local currentMillis = clock.milliseconds()

print(currentMillis) -- 1748187535644

 clock.iso8601(t?)

Returns the current time or optional t in ISO 8601 format (UTC), including milliseconds (e.g., 2025-05-27T23:45:12.123Z).

local currentIso = clock.iso8601()

print(currentIso) -- '2025-05-25T15:40:20.902Z'

 clock.iso8601_parse(str)

Parses str, hopefully an ISO 8601 formatted timestamp, back into a UNIX timestamp in seconds with fractional milliseconds (if present). Assumes UTC and accounts for local timezones automatically.

local example = "2025-05-27T23:45:12.123Z"
local parsed = clock.iso8601_parse(example)

print(parsed) -- 1748389512.123

assert(math.floor(iso8601_parse("2025-05-27T23:45:12.123Z")) == 1748389512)

clock.prettyTime(seconds)

Returns a "pretty" string where the seconds provided are made into an actual sentence.

Yes, of course it uses the Oxford comma before an "and".

local sentence = clock.prettyTime(1000)

print(sentence) -- "16 minutes, and 40 seconds"