reminder

Documentation

Overview

Package reminder sends reminders to the minder server to process entities in background.

Index

• type Interface
  • func NewReminder(ctx context.Context, store db.Store, config *reminderconfig.Config) (Interface, error)

Types

type Interface

type Interface interface {
	// Start starts the reminder by sending reminders at regular intervals
	Start(ctx context.Context) error

	// Stop stops the reminder service
	Stop()
}

Interface is an interface over the reminder service

func NewReminder

func NewReminder(ctx context.Context, store db.Store, config *reminderconfig.Config) (Interface, error)

NewReminder creates a new reminder instance