einherjar/cache-valkey
2
0
Fork 0
Code Issues Pull Requests Packages Releases 2 Activity

docs(cache-valkey): fix fictional launcher.Register/health.Register in doc examples

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.
(component.go doc comment corrected too.)

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.
This commit is contained in:
Rene Nochebuena
2026-08-07 22:14:06 -06:00
parent 7ccd0694fb
commit 20b2595082
3 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
component.go
+4 -3
View File
@@ -7,10 +7,11 @@ import (
// Component is the full cache-valkey capability: lifecycle management, health checks,
// and all Provider operations.
// Register with launcher and health before starting the application:
// Append it to a launcher, and wire a health endpoint (it satisfies
// observability.Checkable):
//
// launcher.Register(vk)
// health.Register(vk)
// lc.Append(vk)
// srv.Get("/health", health.NewHandler(logger, vk).ServeHTTP)
type Component interface {
lifecycle.Component
observability.Checkable