docs(smtp): fix fictional launcher.Register/health.Register in doc examples #2
@@ -19,8 +19,9 @@
|
||||
import "code.nochebuena.dev/einherjar/smtp"
|
||||
|
||||
mailer := smtp.New(logger, smtp.DefaultConfig())
|
||||
launcher.Append(mailer) // OnInit verifies credentials; OnStop is a no-op
|
||||
health.Register(mailer) // dial check; LevelDegraded
|
||||
lc.Append(mailer) // OnInit verifies credentials; OnStop is a no-op
|
||||
// mailer is observability.Checkable (dial check, LevelDegraded):
|
||||
srv.Get("/health", health.NewHandler(logger, mailer).ServeHTTP)
|
||||
```
|
||||
|
||||
When `cfg.Host` is empty, `New` returns a no-op that logs every `Send` call at debug level and always returns nil. No code changes are needed between environments.
|
||||
|
||||
@@ -12,8 +12,12 @@
|
||||
// # Lifecycle Registration
|
||||
//
|
||||
// client := smtp.New(logger, cfg)
|
||||
// launcher.Register(client)
|
||||
// health.Register(client)
|
||||
// lc.Append(client) // lifecycle: OnInit → OnStop
|
||||
//
|
||||
// client satisfies [observability.Checkable], so it can back a health endpoint via
|
||||
// web/health.NewHandler:
|
||||
//
|
||||
// srv.Get("/health", health.NewHandler(logger, client).ServeHTTP)
|
||||
//
|
||||
// # Sending
|
||||
//
|
||||
|
||||
Reference in New Issue
Block a user