notify

Documentation

Overview

Package notify is the shared vocabulary for outbound alerts: a small event and the interface every channel (Web Push, Telegram, …) implements. Keeping it standalone lets the watcher fan one event out to every enabled channel without any of them importing each other.

Index

• type Event
• type Notifier

Types

type Event

type Event struct {
	Title string `json:"title"`
	Body  string `json:"body"`
	Tag   string `json:"tag"`
}

Event is one alert. Tag collapses repeats of the same kind on channels that support it (Web Push).

type Notifier

type Notifier interface {
	Notify(Event)
	Has() bool
}

Notifier is one delivery channel. Has reports whether it has anyone to deliver to, so the watcher can skip work when every channel is empty.