period

Documentation

Overview

Package period contains extensions for time.Duration to represent days and months.

Index

• Constants
• type Period
  • func Parse(str string) (Period, bool)
  • func (p Period) Duration() time.Duration
  • func (p Period) String() string

Constants

const (
	// Day represents the amount of time in a single day.
	Day = Period(time.Hour * 24)
	// Week represents the amount of time in a single week.
	Week = Day * 7
	// Month represents the amount of time in 30 days.
	Month = Day * 30
	// Year represents the amount of time in a year.
	Year = Day * 365
)

nolint: gomnd

Types

type Period

type Period time.Duration

The Period type represents larger time.Duration constants than those provided in the standard library.

func Parse

func Parse(str string) (Period, bool)

Parse the given string as a Period. Returns false if the string does not match a period value.

func (Period) Duration

func (p Period) Duration() time.Duration

Duration returns the Period as a time.Duration.

func (Period) String

func (p Period) String() string