timejuice

Documentation

Overview

Description: Time related helper functions to manage timezones, weekdays, and payroll weeks.

Index

• func GetFirstDayOfMonth(t time.Time) time.Time
• func GetFirstMondayOfYear(ctx context.Context, year int) time.Time
• func GetLastSundayOfPayPeriods(ctx context.Context, year int) time.Time
• func GetMondayOfGivenPeriod(t time.Time) time.Time
• func GetNextSundayOfGivenPeriod(t time.Time) time.Time
• func GetPayrollWeekNumber(ctx context.Context, t time.Time) int
• func GetTimeOfWeekday(t time.Time, targetWeekday time.Weekday) time.Time
• func IsUTCDate(d time.Time) bool
• func NowWithPrecision(precision time.Duration) time.Time
• func SwapTimezone(date time.Time, timezone string, toUTC bool) (time.Time, error)

Functions

func GetFirstDayOfMonth

func GetFirstDayOfMonth(t time.Time) time.Time

GetFirstDayOfMonth retrieves the first day of the month for the given date.

func GetFirstMondayOfYear

func GetFirstMondayOfYear(ctx context.Context, year int) time.Time

GetFirstMondayOfYear retrieves the first Monday of the given year.

func GetLastSundayOfPayPeriods

func GetLastSundayOfPayPeriods(ctx context.Context, year int) time.Time

GetLastSundayOfPayPeriods retrieves the last Sunday before the first Monday of the given year.

func GetMondayOfGivenPeriod

func GetMondayOfGivenPeriod(t time.Time) time.Time

GetMondayOfGivenPeriod retrieves the Monday of the week the given time.Time object is in.

func GetNextSundayOfGivenPeriod

func GetNextSundayOfGivenPeriod(t time.Time) time.Time

GetNextSundayOfGivenPeriod retrieves the next Sunday after the given time.Time object.

func GetPayrollWeekNumber

func GetPayrollWeekNumber(ctx context.Context, t time.Time) int

GetPayrollWeekNumber retrieves the payroll week number for the given date, from 1 trough 53, where the first payroll week is the first Monday of the year.

func GetTimeOfWeekday

func GetTimeOfWeekday(t time.Time, targetWeekday time.Weekday) time.Time

GetTimeOfWeekday retrieves the time of the given weekday within the given time.Time object.

func IsUTCDate

func IsUTCDate(d time.Time) bool

IsUTCDate checks if the given date is in UTC format.

func NowWithPrecision

func NowWithPrecision(precision time.Duration) time.Time

NewWithPrecision returns a new now time.Time (UTC) with the given precision.

func SwapTimezone

func SwapTimezone(date time.Time, timezone string, toUTC bool) (time.Time, error)

SwapTimezone takes a date (which can be in any timezone) and returns the date in the specified timezone.

The original timezone is overridden by the new timezone.

This method does not perform any timezone conversion. It simply changes the timezone of the date.

If toUTC is true, the returned date is converted to UTC.