timex

package

v0.0.5 Latest Latest Go to latest Published: Oct 2, 2026 License: MIT Imports: 3 Imported by: 0

Details

Package timex provides a Ticker abstraction with a fake implementation for deterministic, clock-injectable tests of periodic logic.

This section is empty.

View Source

var ErrTimeout = errors.New("timex: wait timeout")

ErrTimeout is returned by FakeTicker.Wait when the deadline elapses first.

This section is empty.

type FakeTicker struct {
	// contains filtered or unexported fields
}

FakeTicker is a manually-driven Ticker for tests.

func NewFakeTicker() *FakeTicker

NewFakeTicker returns a FakeTicker that must be advanced with Tick.

func (ft *FakeTicker) Chan() <-chan time.Time

Chan returns the tick channel.

func (ft *FakeTicker) Done() <-chan struct{}

Done returns a channel closed when Stop is called.

func (ft *FakeTicker) Stop()

Stop closes the Done channel; it is safe to call multiple times.

func (ft *FakeTicker) Tick()

Tick emits a single tick.

func (ft *FakeTicker) Wait(d time.Duration) error

Wait blocks until Stop is called or the duration elapses, whichever first.

type Ticker interface {
	// Chan returns the tick channel.
	Chan() <-chan time.Time
	// Stop stops the ticker.
	Stop()
}

Ticker emits periodic ticks.

func NewTicker(d time.Duration) Ticker

NewTicker returns a real Ticker with the given interval.