cron

package

v0.18.1 Latest Latest Go to latest Published: Aug 6, 2025 License: MIT Imports: 8 Imported by: 0

Details

Package cron provides support for Zero cron jobs.

This section is empty.

This section is empty.

This section is empty.

type Job func(ctx context.Context) error

Job represents a cron job.

type NullScheduler struct{}

NullScheduler is a no-op scheduler used when no cron jobs are defined.

func (n *NullScheduler) Register(name string, schedule time.Duration, job Job) error

Register does nothing for the null scheduler.

type Schedule struct {
	// contains filtered or unexported fields
}

func (s *Schedule) NextRun() time.Time

NextRun returns the next time the job should run.

func (s *Schedule) String() string

type Scheduler struct {
	// contains filtered or unexported fields
}

func NewNullScheduler() *Scheduler

NewNullScheduler creates a new null scheduler.

func NewScheduler(ctx context.Context, logger *slog.Logger, leaser leases.Leaser) *Scheduler

NewScheduler creates a new cron scheduler.

The Scheduler uses leases.Leaser to prevent cron jobs from running concurrently.

func (s *Scheduler) Register(name string, schedule time.Duration, job Job) error

Register a new cron job.