period

package

v0.1.78 Latest Latest Go to latest Published: Apr 18, 2025 License: Apache-2.0 Imports: 3 Imported by: 1

Details

This section is empty.

This section is empty.

This section is empty.

type Client interface {
	contract.PeriodOperator
}

func NewClient(opts ClientOptions) Client

type ClientOption func(*ClientOptions)

func WithOffset(x int) ClientOption

type ClientOptions struct {
	Offset int
}

func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions

type DefaultTool struct {
	T *contract.Tool[Client]
}

func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool

func (d *DefaultTool) FirstDayOfMonth(ctx context.Context, date time.Time) (time.Time, error)

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

func (d *DefaultTool) FirstPeriodStartDate(ctx context.Context, year int) (time.Time, error)

FirstPeriodStartDate retrieves the date of the first day of the first period of the given year.

func (d *DefaultTool) LastDayOfLastPeriod(ctx context.Context, year int) (time.Time, error)

LastDayOfLastPeriod retrieves the last day of the last period of the given year.

func (d *DefaultTool) PeriodNumber(ctx context.Context, date time.Time) (int, error)

PeriodNumber retrieves the period week number for the given date.

func (d *DefaultTool) TimeOfWeekday(ctx context.Context, date time.Time, weekday time.Weekday) (time.Time, error)

TimeOfWeekday retrieves the date of the specified weekday within the same week as the given date.