taigrr/bubbletea
1
0
Fork 0
mirror of https://github.com/taigrr/bubbletea.git synced 2026-04-02 02:59:09 -07:00
Code Issues Packages Projects Releases Wiki Activity

Improve examples in docs

Browse Source
This commit is contained in:
Christian Rocha
2020-07-30 11:29:20 -04:00
parent 17035473db
commit 6fcdf9908f
3 changed files with 39 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
commands.go
View File

@@ -15,6 +15,15 @@ import (
// the entire specified duration. For example, if we're ticking for one minute
// and the clock is at 12:34:20 then the next tick will happen at 12:35:00, 40
// seconds later.
//
// To produce the command, pass a duration and a fnuction which returns
// a message containing the time at which the tick occurred.
//
// type TickMsg time.Time
//
// cmd := Every(time.Second, func(t time.Time) Msg {
// return TickMsg(t)
// })
func Every(duration time.Duration, fn func(time.Time) Msg) Cmd {
return func() Msg {
n := time.Now()
@@ -24,9 +33,18 @@ func Every(duration time.Duration, fn func(time.Time) Msg) Cmd {
}
}
// Tick is a command that at an interval independent of the system clock at the
// given duration. That is, the timer begins when precisely when invoked, and
// runs for its entire duration.
// Tick produces a command that at an interval independent of the system clock
// at the given duration. That is, the timer begins when precisely when
// invoked, and runs for its entire duration.
//
// To produce the command, pass a duration and a fnuction which returns
// a message containing the time at which the tick occurred.
//
// type TickMsg time.Time
//
// cmd := Tick(time.Second, func(t time.Time) Msg {
// return TickMsg(t)
// })
func Tick(d time.Duration, fn func(time.Time) Msg) Cmd {
return func() Msg {
t := time.NewTimer(d)