CalendarPeriod

An amount of calendar time in whole years, months and days, written P1Y2M10D: unlike a Duration, a month is a month, however many days it has. It has no order, and == compares part by part.

Time and calendar; not ordered; since Jadpo 0.1.0.

Make one

Build one from its fields, CalendarPeriod { years: ... months: ... days: ... }.

text.parse(raw, as: CalendarPeriod) reads one from its text; text that isn't one at all fails malformed, such as 1 month, P or PT1H.

This operation gives one: temporal.period_between.

Fields

Text, JSON and storage

text.from writes its canonical text, the one form text.parse reads back. JSON sends its canonical text as a string.

It is stored in 3 columns, each named for the field, _ and its suffix. This is P-1M-3D:

Shown to people

text.format(value, locale:) shows it to people in their locale.

With locale: Locale.en_gb:

Operations

• temporal.period_between(start: CalendarDate, end: CalendarDate) -> CalendarPeriod: Whole years, months and days from start to end, so start plus the period is end; each part negative when end is earlier.

Like every standard type, it also has the contract's own operations: text.parse, text.from, text.format, json.read, json.write and ==. It isn't ordered, so < and sorting don't take it. Every standard type meets one contract says how they work.