clock

Documentation

Overview

Package clock provides time-related utilities and wrappers

Index

• Variables
• func MockTime() *clock.Mock
• func Now() time.Time
• func Reset()
• func Since(t time.Time) time.Duration
• type Clock
  • func (c Clock) Now(loc *time.Location) time.Time
  • func (c Clock) Unix(sec int64, nsec int64) time.Time
• type Timer
  • func AfterFunc(d time.Duration, f func()) Timer

Variables

var DefaultClock = Clock{clock.New()}

DefaultClock is the underlying Clock used and can be overridden to mock

Functions

func MockTime

func MockTime() *clock.Mock

MockTime sets up the DefaultClock with a consistent time so it can be used across tests

func Now

func Now() time.Time

func Reset

func Reset()

Reset returns the DefaultClock to real time

func Since

func Since(t time.Time) time.Duration

Types

type Clock

type Clock struct {
	clock.Clock
}

Clock allows mocking time

func (Clock) Now

func (c Clock) Now(loc *time.Location) time.Time

func (Clock) Unix

func (c Clock) Unix(sec int64, nsec int64) time.Time

type Timer

type Timer interface {
	Reset(d time.Duration) bool
}

func AfterFunc

func AfterFunc(d time.Duration, f func()) Timer