AtomicGo | schedule
---
Documentation
|
Contributing
|
Code of Conduct
---
go get atomicgo.dev/schedule
# schedule
```go
import "atomicgo.dev/schedule"
```
Package schedule provides a simple scheduler for Go.
It can run a function at a given time, in a given duration, or repeatedly at a given interval.
## Index
- [type Task](<#Task>)
- [func After\(d time.Duration, task func\(\)\) \*Task](<#After>)
- [func At\(t time.Time, task func\(\)\) \*Task](<#At>)
- [func Every\(interval time.Duration, task func\(\) bool\) \*Task](<#Every>)
- [func \(s \*Task\) ExecutesIn\(\) time.Duration](<#Task.ExecutesIn>)
- [func \(s \*Task\) IsActive\(\) bool](<#Task.IsActive>)
- [func \(s \*Task\) NextExecutionTime\(\) time.Time](<#Task.NextExecutionTime>)
- [func \(s \*Task\) StartedAt\(\) time.Time](<#Task.StartedAt>)
- [func \(s \*Task\) Stop\(\)](<#Task.Stop>)
- [func \(s \*Task\) Wait\(\)](<#Task.Wait>)
## type [Task]()
Task holds information about the running task and can be used to stop running tasks.
```go
type Task struct {
// contains filtered or unexported fields
}
```
### func [After]()
```go
func After(d time.Duration, task func()) *Task
```
After executes the task after the given duration. The function is non\-blocking. If you want to wait for the task to be executed, use the Task.Wait method.
Example
```go
package main
import (
"fmt"
"time"
"atomicgo.dev/schedule"
)
func main() {
task := schedule.After(5*time.Second, func() {
fmt.Println("5 seconds are over!")
})
fmt.Println("Some stuff happening...")
task.Wait()
}
```
Example
```go
package main
import (
"fmt"
"time"
"atomicgo.dev/schedule"
)
func main() {
task := schedule.At(time.Now().Add(5*time.Second), func() {
fmt.Println("5 seconds are over!")
})
fmt.Println("Some stuff happening...")
task.Wait()
}
```
Example
```go
package main
import (
"fmt"
"time"
"atomicgo.dev/schedule"
)
func main() {
task := schedule.Every(time.Second, func() bool {
fmt.Println("1 second is over!")
return true // return false to stop the task
})
fmt.Println("Some stuff happening...")
time.Sleep(10 * time.Second)
task.Stop()
}
```