datetime

README

datetime

extending datetime

Vesions

Installation

To use this package in your Go project, run:

go get -u github.com/gouef/datetime

Contributing

Read Contributing

Contributors

Join our Discord Community! 🎉

Click above to join our community on Discord!

Documentation

Index

• Constants
• Variables
• func Calculate(year int) time.Time
• func DaysInMonth(year int, month int) int
• func DaysInMonthByDate(t time.Time) int
• func DaysInMonthList(year int, month int) []int
• func GetDate(year, month, day int) time.Time
• func GetEaster(year int) time.Time
• func GetGoodFriday(year int) time.Time
• func GetMonday(year int) time.Time
• type DateTime
  • func New(year, month, day, hour, minute, second int) (*DateTime, error)
  • func Now() *DateTime
  • func (d *DateTime) After(u Interface) bool
  • func (d *DateTime) Before(u Interface) bool
  • func (d *DateTime) Between(start, end Interface) bool
  • func (d *DateTime) Compare(u Interface) int
  • func (d *DateTime) Equal(u Interface) bool
  • func (d *DateTime) FromString(value string) (Interface, error)
  • func (d *DateTime) IsWeekend() bool
  • func (d *DateTime) Time() time.Time
  • func (d *DateTime) ToString() string
• type Historic
• type HistoricDate
• type Interface
  • func FromString(value string) (Interface, error)
• type Range
  • func NewRange(from, to string, start RangeStart, end RangeEnd) (*Range, error)
  • func NewRangeOptional(from, to string) (*Range, error)
  • func NewRangeStartOptional(from, to string) (*Range, error)
  • func NewRangeStartStrict(from, to string) (*Range, error)
  • func NewRangeStrict(from, to string) (*Range, error)
  • func RangeFromString(value string) (*Range, error)
  • func (r *Range) End() RangeEnd
  • func (r *Range) From() ValueInterface
  • func (r *Range) Is(value any) bool
  • func (r *Range) Start() RangeStart
  • func (r *Range) String() string
  • func (r *Range) To() ValueInterface
• type RangeEnd
• type RangeInterface
• type RangeStart
• type Value
  • func StringToValue(value string) (Value, error)
  • func (d Value) Date() Interface
• type ValueInterface

Constants

const (
	YearRegexp     = `(\d+)`
	MonthRegexp    = `(0[1-9]|1[0-2])`
	DayRegexp      = `(0[1-9]|[12][0-9]|3[01])`
	HourRegexp     = `(0[0-9]|1[0-9]|2[0-3])`
	MinuteRegexp   = `[0-5][0-9]`
	SecondRegexp   = `[0-5][0-9]`
	DateRegexp     = YearRegexp + `-` + MonthRegexp + `-` + DayRegexp
	TimeRegexp     = `(` + HourRegexp + `):(` + MinuteRegexp + `):(` + SecondRegexp + `)`
	DateTimeRegexp = `((` + DateRegexp + `) (` + TimeRegexp + `))`
	RangeRegexp    = `^([\[\(])` + DateTimeRegexp + `?\s*,\s*` + DateTimeRegexp + `?([\]\)])$`
)

const (
	Regexp = `^((\d+)-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]))\s(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$`
)

Variables

var (
	// RangeStartStrict can not be equal
	RangeStartStrict RangeStart = "["
	// RangeStartOptional can be equal
	RangeStartOptional RangeStart = "("
	// RangeEndStrict can not be equal
	RangeEndStrict RangeEnd = "]"
	// RangeEndOptional can be equal
	RangeEndOptional RangeEnd = ")"
)

Functions

func Calculate

func Calculate(year int) time.Time

func DaysInMonth

func DaysInMonth(year int, month int) int

func DaysInMonthByDate

func DaysInMonthByDate(t time.Time) int

func DaysInMonthList

func DaysInMonthList(year int, month int) []int

func GetDate

func GetDate(year, month, day int) time.Time

func GetEaster

func GetEaster(year int) time.Time

func GetGoodFriday

func GetGoodFriday(year int) time.Time

func GetMonday

func GetMonday(year int) time.Time

Types

type DateTime

type DateTime struct {
	Year     int
	Month    int `validate:"min=1,max=12"`
	Day      int `validate:"min=1,max=31"`
	Hour     int `validate:"min=0,max=23"`
	Minute   int `validate:"min=0,max=59"`
	Second   int `validate:"min=0,max=59"`
	DateTime time.Time
}

func New

func New(year, month, day, hour, minute, second int) (*DateTime, error)

func Now

func Now() *DateTime

func (*DateTime) After

func (d *DateTime) After(u Interface) bool

func (*DateTime) Before

func (d *DateTime) Before(u Interface) bool

func (*DateTime) Between

func (d *DateTime) Between(start, end Interface) bool

func (*DateTime) Compare

func (d *DateTime) Compare(u Interface) int

Compare compares the date instant d with u. If d is before u, it returns -1; if d is after u, it returns +1; if they're the same, it returns 0.

func (*DateTime) Equal

func (d *DateTime) Equal(u Interface) bool

func (*DateTime) FromString

func (d *DateTime) FromString(value string) (Interface, error)

func (*DateTime) IsWeekend

func (d *DateTime) IsWeekend() bool

func (*DateTime) Time

func (d *DateTime) Time() time.Time

func (*DateTime) ToString

func (d *DateTime) ToString() string

type Historic

type Historic string

var (
	BeforeChrist Historic = "bc"
	AfterChrist  Historic = "ac"
)

type HistoricDate

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

type Interface

type Interface interface {
	ToString() string
	FromString(value string) (Interface, error)
	Time() time.Time
	Equal(u Interface) bool
	Between(start, end Interface) bool
	Before(u Interface) bool
	After(u Interface) bool
	Compare(u Interface) int
}

func FromString

func FromString(value string) (Interface, error)

type Range

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

func NewRange

func NewRange(from, to string, start RangeStart, end RangeEnd) (*Range, error)

func NewRangeOptional

func NewRangeOptional(from, to string) (*Range, error)

func NewRangeStartOptional

func NewRangeStartOptional(from, to string) (*Range, error)

func NewRangeStartStrict

func NewRangeStartStrict(from, to string) (*Range, error)

func NewRangeStrict

func NewRangeStrict(from, to string) (*Range, error)

func RangeFromString

func RangeFromString(value string) (*Range, error)

func (*Range) End

func (r *Range) End() RangeEnd

func (*Range) From

func (r *Range) From() ValueInterface

func (*Range) Is

func (r *Range) Is(value any) bool

func (*Range) Start

func (r *Range) Start() RangeStart

func (*Range) String

func (r *Range) String() string

func (*Range) To

func (r *Range) To() ValueInterface

type RangeEnd

type RangeEnd string

RangeEnd end bracket

type RangeInterface

type RangeInterface interface {
	Start() RangeStart
	End() RangeEnd
	From() ValueInterface
	To() ValueInterface
	String() string
	Is(value any) bool
}

type RangeStart

type RangeStart string

RangeStart start bracket

type Value

type Value string

func StringToValue

func StringToValue(value string) (Value, error)

func (Value) Date

func (d Value) Date() Interface

type ValueInterface

type ValueInterface interface {
	Date() Interface
}