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

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

Browse Source 
The package-doc examples showed a fictional launcher.Register / health.Register
API (and launcher.Append as a package func). Corrected to the real wiring:
lc.Append + web/health.NewHandler(...).ServeHTTP.

Documentation-only. No code, API, or dependency changes; version stays v1.1.0
(the v1.1.0 tag is moved to include this fix). Verified by compiling the
corrected pattern against the real API.

Reviewed-on: #2
Co-authored-by: Rene Nochebuena Guerrero <rene@nochebuena.dev>
Co-committed-by: Rene Nochebuena Guerrero <rene@nochebuena.dev>
This commit was merged in pull request #2.
This commit is contained in:
Rene Nochebuena
2026-08-07 22:20:14 -06:00
committed by NOCHEBUENADEV
parent 6a1fa2e697
commit 585c76a525
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 dbsqlite "code.nochebuena.dev/einherjar/db-sqlite" import dbsqlite "code.nochebuena.dev/einherjar/db-sqlite"
db := dbsqlite.New(logger, dbsqlite.DefaultConfig()) db := dbsqlite.New(logger, dbsqlite.DefaultConfig())
launcher.Append(db) // OnInit opens database; OnStop closes it lc.Append(db) // OnInit opens database; OnStop closes it
health.Register(db) // BucketExists-style check; LevelDegraded // db is observability.Checkable (LevelDegraded):
srv.Get("/health", health.NewHandler(logger, db).ServeHTTP)
``` ```
### Querying ### Querying
doc.go
+6 -2
View File
@@ -15,8 +15,12 @@
// # Lifecycle Registration // # Lifecycle Registration
// //
// db := sqlite.New(logger, cfg) // db := sqlite.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
// //