cron

Documentation

Overview

Package cron handles anything related to time.

Package cron handles anything related to time.

Index

• func DescribeLocation(loc *time.Location) string
• func DescribeSchedule(s Schedule) string
• func Next(s Schedule) time.Time
• func PrintCountdown(ppfmt pp.PP, activity string, interval time.Duration)
• type Schedule
  • func MustNew(spec string) Schedule
  • func New(spec string) (Schedule, error)

Functions

func DescribeLocation

func DescribeLocation(loc *time.Location) string

DescribeLocation gives a description of loc that combines loc.String() and time offset.

func DescribeSchedule

func DescribeSchedule(s Schedule) string

DescribeSchedule gives back the original cron string.

func Next

func Next(s Schedule) time.Time

Next gets the next scheduled time. It returns the zero value for nil.

func PrintCountdown

func PrintCountdown(ppfmt pp.PP, activity string, interval time.Duration)

Types

type Schedule

type Schedule = interface {
	Next() time.Time
	Describe() string
}

Schedule tells the next time a scheduled event should happen.

func MustNew

func MustNew(spec string) Schedule

MustNew creates a new Schedule, and panics if it fails to parse the input.

func New

func New(spec string) (Schedule, error)

New creates a new Schedule.