isodate

package

v1.0.0-beta.214 Latest Latest Go to latest Published: Jun 25, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation ¶

Package datex is a wrapper around github.com/rickb777/date/v2 and github.com/rickb777/period so we don't depend on it directly.

View Source

const MAX_SAFE_ITERATION_COUNT = 1_000_000

This section is empty.

This section is empty.

type Period struct {
	period.Period
}

func Between(start time.Time, end time.Time) Period

func FromDuration(d time.Duration) Period

FromDuration creates an IMPRECISE Period from a time.Duration

func MustParse(t *testing.T, s string) Period

func NewPeriod(years, months, weeks, days, hours, minutes, seconds int) Period

func (p Period) Add(p2 Period) (Period, error)

func (p Period) DivisibleBy(smaller Period) (bool, error)

DivisibleBy returns true if the period is divisible by the smaller period (in hours).

func (p *Period) Equal(v *Period) bool

Equal returns true if the two periods are equal

func (p Period) ISOString() String

ISOString() returns the ISO8601 string representation of the period

func (d *Period) ISOStringPtrOrNil() *String

ISOStringPtrOrNil() returns the ISO8601 string representation of the period or if Period is nil, returns nil

func (p Period) InHours(daysInMonth int) (alpacadecimal.Decimal, error)

InHours returns the value of the period in hours

func (p Period) Normalise(exact bool) Period

func (p Period) Simplify(exact bool) Period

func (p Period) Subtract(p2 Period) (Period, error)

type String period.ISOString

func (i String) Parse() (Period, error)

func (i *String) ParsePtrOrNil() (*Period, error)

ParsePtrOrNil parses the ISO8601 string representation of the period or if ISOString is nil, returns nil

func (i String) String() string