cronticker

README

cronticker

Golang ticker that works with Cron scheduling.

Import it

go get github.com/krayzpipes/cronticker/cronticker

import "github.com/krayzpipes/cronticker/cronticker"

Usage

Create a new ticker:

ticker, err := NewTicker("TZ=America/New_York 0 0 0 ? * SUN")

You can listen for messages on the ticker's channel like this:

tickerTime := <-ticker.C

You can reset the ticker to a new cron schedule

err := ticker.Reset("0 0 0 ? * MON,TUE,WED")

And you can stop it

ticker.Stop()

To make sure you always clean up the goroutines used by the ticker, it's good practice to defer Stop() after ticker creation.

ticker, _ := NewTicker("@daily")
defer ticker.Stop()

Cron Schedule Format

The Cron schedule can be in Unix or Quartz format. Directives like '@weekly' or '@daily' can also be parsed as defined in the package github.com/robfig/cron/v3.

You may add the TimeZone/location to the beginning of the cron schedule to change the time zone. Default is UTC if TZ=Whatever is not prepended to the cron schedule.

Examples

Cron Schedule	Type/Format	Description
"TZ=America/Los_Angeles 0 0 * * *"	Unix	Daily at 12 AM in Los Angeles
"TZ=America/Los_Angeles 0 0 0 ? * MON"	Quartz	Mondays at 12 AM in Los Angeles
"TZ=America/Los_Angeles @daily"	Directive	Daily at 12 AM in Los Angeles
"@daily"	Directive	Daily at 12 AM UTC

You may also use the following characters:

Character	Description	Example
-	Range	4-5
/	Step	0/5
*	Any	*/5
,	List	1,4,5