cron

Documentation

Overview

Package cron stores recurring task definitions and run history.

Index

• func IsDue(entry Entry, now time.Time) bool
• type Entry
• type Store
  • func NewStore(configHome string) Store
  • func (s Store) Create(schedule string, prompt string, description string) (Entry, error)
  • func (s Store) Delete(id string) (Entry, error)
  • func (s Store) Due(now time.Time) ([]Entry, error)
  • func (s Store) Get(id string) (Entry, error)
  • func (s Store) List() ([]Entry, error)
  • func (s Store) MarkRun(id string, now time.Time) (Entry, error)
  • func (s Store) SetEnabled(id string, enabled bool) (Entry, error)

Functions

func IsDue

func IsDue(entry Entry, now time.Time) bool

Types

type Entry

type Entry struct {
	ID          string     `json:"cron_id"`
	Schedule    string     `json:"schedule"`
	Prompt      string     `json:"prompt"`
	Description string     `json:"description,omitempty"`
	Enabled     bool       `json:"enabled"`
	CreatedAt   time.Time  `json:"created_at"`
	UpdatedAt   time.Time  `json:"updated_at"`
	LastRunAt   *time.Time `json:"last_run_at,omitempty"`
	RunCount    int        `json:"run_count"`
}

type Store

type Store struct {
	ConfigHome string
}

func NewStore

func NewStore(configHome string) Store

func (Store) Create

func (s Store) Create(schedule string, prompt string, description string) (Entry, error)

func (Store) Delete

func (s Store) Delete(id string) (Entry, error)

func (Store) Due

func (s Store) Due(now time.Time) ([]Entry, error)

func (Store) Get

func (s Store) Get(id string) (Entry, error)

Get returns one scheduled entry by ID.

func (Store) List

func (s Store) List() ([]Entry, error)

func (Store) MarkRun

func (s Store) MarkRun(id string, now time.Time) (Entry, error)

func (Store) SetEnabled

func (s Store) SetEnabled(id string, enabled bool) (Entry, error)

SetEnabled changes whether a scheduled entry can become due.