tools/timer
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update ReadMe.md

Browse Source
This commit is contained in:
tangent
2026-09-21 23:50:30 -06:00
parent 97b18483a0
commit 87a5b86e69
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ReadMe.md
+9 -1
View File
@@ -4,7 +4,7 @@ Easy timers in Lua. Spiritual successor to kikito's cron.lua
Public domain! Who needs an IP anyhow? Public domain! Who needs an IP anyhow?
## Usage ## Usage
Can be used as a drop-in replacement for [kikito's cron.lua](https://github.com/kikito/cron.lua), Can be *mostly* used as a drop-in replacement for [kikito's cron.lua](https://github.com/kikito/cron.lua),
but that misses the biggest benefit, which is the timer library itself managing but that misses the biggest benefit, which is the timer library itself managing
timers, including discarding expired timers: timers, including discarding expired timers:
@@ -36,3 +36,11 @@ end
Timers can have their time set to a new value with `my_timer:reset(time)`. If Timers can have their time set to a new value with `my_timer:reset(time)`. If
nothing is passed, they will be set to `0`. nothing is passed, they will be set to `0`.
---
Incompatibilities / Changes from kikito's cron.lua:
- Number values are not checked or restricted.
- Different error message for callback not being callable.
- If a one-time timer is run by `timer.update`, it will *no longer be updated*
by `timer.update`, even if reset.