notifications

Documentation

Index

• type Notifier
  • func Init(config map[string]string) Notifier

Types

type Notifier

type Notifier interface {
	// Notify will be called after a correction is performed.
	// It will be given the correction's message, the result of executing it,
	// and a flag for whether this is a preview or if it actually ran.
	// If preview is true, err will always be nil.
	Notify(domain, provider string, message string, err error, preview bool)
	// Done will be called exactly once after all notifications are done. This will allow "batched" notifiers to flush and send
	Done()
}

Notifier is a type that can send a notification

func Init

func Init(config map[string]string) Notifier

Init will take the given config map (from creds.json notifications key) and create a single Notifier with all notifications it has full config for.