xevion/go-ha
1
0
Fork 0
mirror of https://github.com/Xevion/go-ha.git synced 2025-12-08 08:07:21 -06:00
Code Issues Packages Projects Releases Wiki Activity

fix event listener documentation

Browse Source
This commit is contained in:
Sam Lewis
2025-06-02 20:28:00 -04:00
parent b275a9c107
commit a25c550648
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -203,16 +203,16 @@ eventListener := ga.
app.RegisterEventListeners(eventListener) app.RegisterEventListeners(eventListener)
``` ```
Event listeners support several additional functions to customize the listener: Event listeners have other functions to change the behavior.
| Method | Description | | Function | Info |
|--------|-------------| | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `OnlyBetween(start, end string)` | Only trigger between specific times of day | | OnlyBetween("03:00", "14:00") | Only run your function between two specified times of day |
| `OnlyAfter(start string)` | Only trigger after a specific time of day | | OnlyAfter("03:00") | Only run your function after a specified time of day |
| `OnlyBefore(end string)` | Only trigger before a specific time of day | | OnlyBefore("03:00") | Only run your function before a specified time of day |
| `Throttle(duration DurationString)` | Limit how frequently the listener can trigger | | Throttle("30s") | Minimum time between function calls |
| `ExceptionDates(dates ...time.Time)` | Specify dates when the listener should not run | | ExceptionDates(time.Time, ...time.Time) | A one time exception on the given date. Time is ignored, applies to whole day. Functions like a "blocklist" |
| `ExceptionRange(start, end time.Time)` | Specify date ranges when the listener should not run | | ExceptionRange(time.Time, time.Time) | A one time exception between the two date/times. Both date and time are considered. Functions like a "blocklist" |
The callback function receives three parameters: The callback function receives three parameters:
```go ```go