Documentation
¶
Overview ¶
Package clock provides a thin re-export of github.com/benbjohnson/clock so the rest of the codebase imports a single internal path and is insulated from upstream API changes.
Usage — production code ¶
type Handler struct {
clk clock.Clock
// ...
}
func NewHandler(clk clock.Clock /* ... */) *Handler {
return &Handler{clk: clk}
}
// Use clk.Now() everywhere, never time.Now() directly.
Usage — tests ¶
mock := clock.NewMock() h := NewHandler(mock) mock.Add(35 * time.Second) // instant — no real sleep required
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Clock ¶
Clock is the injectable time-source interface. Production code receives clock.New(); tests receive clock.NewMock().
- Now() — current time
- After(d) — channel that fires after d (like time.After)
- NewTicker(d) — like time.NewTicker; must be stopped
- NewTimer(d) — like time.NewTimer; must be stopped or reset
- Sleep(d) — like time.Sleep (instantly skippable in tests)
- Since(t) — shorthand for Now().Sub(t)
- Until(t) — shorthand for t.Sub(Now())
Source Files
Click to show internal directories.
Click to hide internal directories.