crontab

package

v0.10.98 Latest Latest Go to latest Published: Jul 21, 2026 License: MIT Imports: 14 Imported by: 0

Details

This section is empty.

View Source

var New = c.NewWithContextValidate[Scheduler, SchedulerOption]

This section is empty.

type Config struct {
	Jobs map[string]JobConfig `validate:"gt=0,dive,keys,required,endkeys,required"`
}

func (c Config) New(
	ctx context.Context,
	opts ...SchedulerOption,
) (
	Scheduler,
	error,
)

type JobConfig struct {
	Schedule string        `validate:"cron"`
	Timeout  time.Duration `validate:"min=200ms"`
	Enabled  bool
}

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

func (s Scheduler) Run(context.Context) error

func (s Scheduler) Shutdown() error

func (obj Scheduler) Validate() error

func (s Scheduler) WaitForShutdown(ctx context.Context) error

Deprecated: use closer.AddCloser(run.ErrorFn(scheduler.Shutdown)) instead

type SchedulerOption c.OptionWithContext[Scheduler]

func WithGocronOptions(opts ...gocron.SchedulerOption) SchedulerOption

func WithJob(jobName string, cfg JobConfig) SchedulerOption

func WithJobRegistry(jobs map[string]run.Fn) SchedulerOption

func WithLogger(logger *zap.Logger) SchedulerOption

func WithShutdownTimeout(t time.Duration) SchedulerOption

Deprecated: Use closer centralized mechanics instead.