period

Package period has types that represent ISO-8601 periods of time.

The two core types are

• ISOString - an ISO-8601 string
• Period - a struct with the seven numbers years, months, weeks, days, hours, minutes and seconds.

These two can be converted to the other.

Period also allows various calculations to be made. Its fields each hold up to 19 digits precision.

Status

The basic API exists but may yet change.

Upgrading

The old version of this was github.com/rickb777/date/period, which had very limited number range and used fixed-point arithmetic.

The new version, here, depends instead on github.com/govalues/decimal, which gives a huge (but finite) number range. There is now a 'weeks' field, which the old version did not have (it followed time.Time API patterns, which don't have weeks).

These functions have changed:

• New now needs one more input parameter for the weeks field (7 parameters in total)
• NewYMD still exists; there is also NewYMWD, which will often be more appropriate.

These methods have changed:

• YearsDecimal, MonthsDecimal, WeeksDecimal, DaysDecimal, HoursDecimal, MinutesDecimal and SecondsDecimal return the fields as decimal.Decimal. They replace the old YearsFloat, MonthsFloat, DaysFloat, HoursFloat, MinutesFloat and SecondsFloat methods. Years, Months, Weeks, Days, Hours, Minutes and Seconds still return int as before.
• DaysIncWeeks and DaysIncWeeksDecimal were added to return d + w * 7, which provides the behaviour similar to the old Days and DaysFloat methods.
• The old ModuloDays was dropped now that weeks are implemented fully.
• OnlyYMD is now OnlyYMWD
• Scale and ScaleWithOverflowCheck have been replaced with Mul, which returns the multiplication product and a possible error.