Skip to content

Commit 4ec563b

Browse files
committed
docs: add timeutil index.md
1 parent 840028e commit 4ec563b

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

docs/src/timeutil/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# What is timeutil?
2+
3+
`timeutil` is a C-backed Lua module for wall-clock time, monotonic time, and
4+
blocking sleep.
5+
6+
It lets Lua read Unix wall-clock timestamps, measure elapsed monotonic time, and
7+
pause execution for a duration.
8+
9+
## Compatibility
10+
11+
`timeutil` supports:
12+
13+
- Lua 5.1
14+
- Lua 5.2
15+
- Lua 5.3
16+
- Lua 5.4
17+
- Lua 5.5
18+
- LuaJIT
19+
20+
## Use Cases
21+
22+
- Get Unix wall-clock time from Lua.
23+
- Measure elapsed time without wall-clock jumps.
24+
- Sleep for fractional-second durations.
25+
- Write timing, polling, timeout, and benchmark code.

0 commit comments

Comments
 (0)