einherjar/db-postgres
2
0
Fork 0
Code Issues Pull Requests Packages Releases 2 Activity

docs(db-postgres): fix fictional launcher.Register/health.Register in doc examples #2

Merged
Rene Nochebuena merged 1 commits from fix/wiring-docs into main 2026-08-07 22:21:06 -06:00
Conversation 0 Commits 1 Files Changed 2
+9 -4
2 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -2
View File
@@ -19,8 +19,9 @@
import dbpg "code.nochebuena.dev/einherjar/db-postgres" import dbpg "code.nochebuena.dev/einherjar/db-postgres"
db := dbpg.New(logger, dbpg.DefaultConfig()) db := dbpg.New(logger, dbpg.DefaultConfig())
launcher.Append(db) // OnInit opens pool; OnStop closes it lc.Append(db) // OnInit opens pool; OnStop closes it
health.Register(db) // PING health check; LevelCritical // db is observability.Checkable (PING health check, LevelCritical):
srv.Get("/health", health.NewHandler(logger, db).ServeHTTP)
``` ```
### Querying ### Querying
doc.go
+6 -2
View File
@@ -13,8 +13,12 @@
// # Lifecycle Registration // # Lifecycle Registration
// //
// db := postgres.New(logger, cfg) // db := postgres.New(logger, cfg)
// launcher.Register(db) // lc.Append(db) // lifecycle: OnInit → OnStart → OnStop
// health.Register(db) //
// db satisfies [observability.Checkable], so it can back a health endpoint via
// web/health.NewHandler:
//
// srv.Get("/health", health.NewHandler(logger, db).ServeHTTP)
// //
// # Querying // # Querying
// //