DEV Community

loading...

Range Over Ticker In Go With Immediate First Tick

wagslane profile image Lane Wagner Originally published at qvault.io on ・2 min read

The Go standard library has a really cool type – Ticker. Tickers are used when you want to do something at a regular interval, similar to JavaScript’s setInterval. Here’s an example:

package main

import (
    "fmt"
    "time"
)

func main() {
    ticker := time.NewTicker(time.Second)
    go func() {
        for range ticker.C {
            fmt.Println("Tick")
        }
    }()

    time.Sleep(time.Second * 4)
    ticker.Stop()
    fmt.Println("Ticker stopped")
}
Enter fullscreen mode Exit fullscreen mode

As per the docs, a ticker is a struct that holds a receive-only channel of time.Time objects.

type Ticker struct {
    C <-chan Time // The channel on which the ticks are delivered.
}
Enter fullscreen mode Exit fullscreen mode

In the example at the beginning of the article, you will notice by running the program that the first tick sent over the channel happens after the first interval of time has elapsed. As such, if you are trying to build, for example, a rate limiter, it can be inconvenient because to get the first immediate execution, it would seem your best option is:

func doSomethingWithRateLimit() {
    ticker := time.NewTicker(time.Second)
    doSomething()
    for range ticker.C {
        doSomething()
    }
}
Enter fullscreen mode Exit fullscreen mode

There is in fact a better option!

In go, a channel can also be iterated over in a normal for-loop, so our solution is to build a for loop that executes automatically on the first iteration, then waits for each subsequent loop.

package main

import (
    "fmt"
    "time"
)

func main() {
    ticker := time.NewTicker(time.Minute)
    for ; true; <-ticker.C {
        fmt.Println("hi")
    }
}
Enter fullscreen mode Exit fullscreen mode

Hopefully this helps keep redundant code out of your projects!

Thanks For Reading

Hit me up on twitter @wagslane if you have any questions or comments.

Follow me on Dev.to: wagslane

The post Range Over Ticker In Go With Immediate First Tick appeared first on Qvault.

Discussion (0)

pic
Editor guide