intervalIntersectionZoned
Signature
Section titled “Signature”intervalIntersectionZoned(aStart: string, aEnd: string, bStart: string, bEnd: string): { start: string; end: string; }import { intervalIntersectionZoned } from "@northguild/gmt/zoned/interval";Return the overlapping span of two zoned intervals, or null when they do not overlap.
- Uses
Temporal.ZonedDateTime.comparefor comparison (same instant semantics). - Adjacent intervals (e.g.
aEnd === bStart) share one instant and DO overlap. - Returns
nullif either interval is invalid (start > end). - Returns
nullon invalid input (wrong type, malformed strings, leap seconds). - Accepts GMT calendar-annotated zoned strings (as produced by
convertZonedToCalendar) as well as bare ISO ones — E7 (issue #152) — but rejects a mismatched pair: every endpoint must name the same calendar system (E7’s D4-zoned). Unlike the ordering functions, this one returns a value the caller reads back as a datetime, and there is no principled way to pick one endpoint’s calendar as the answer’s. Rejection also keeps a uniform policy across all eight value-returning zoned set operations, four of which return arrays — a per-element “winner’s tag” would produce a result set whose members disagree about which calendar they are in. (intervalUnionZoned’s existing “winning endpoint’s time zone wins” is not precedent: the zone is a property of the surviving point, the calendar is a property of the answer.) A mismatch returns the sentinel. - Output boundaries are re-derived in the resolved calendar via
formatZonedInCalendar, never copied from an input string (E7’s D7-zoned). - Still rejects Temporal’s own
[timeZone][u-ca=...]RFC 9557 ordering — seeregex/calendar-zoned-date-time.ts.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
aStart |
string |
ISO 8601 zoned datetime string for the first interval start |
aEnd |
string |
ISO 8601 zoned datetime string for the first interval end |
bStart |
string |
ISO 8601 zoned datetime string for the second interval start |
bEnd |
string |
ISO 8601 zoned datetime string for the second interval end |
Returns
Section titled “Returns”{ start, end } with the overlapping span, or null on invalid input / no overlap
Examples
Section titled “Examples”intervalIntersectionZoned("2024-01-01T00:00:00+00:00[UTC]", "2024-06-30T23:59:59+00:00[UTC]", "2024-04-01T00:00:00+00:00[UTC]", "2024-12-31T23:59:59+00:00[UTC]") // { start: "2024-04-01T00:00:00+00:00[UTC]", end: "2024-06-30T23:59:59+00:00[UTC]" }intervalIntersectionZoned("2024-01-01T00:00:00+00:00[UTC]", "2024-06-30T23:59:59+00:00[UTC]", "2024-07-01T00:00:00+00:00[UTC]", "2024-12-31T23:59:59+00:00[UTC]") // nullintervalIntersectionZoned("invalid", "2024-06-30T23:59:59+00:00[UTC]", "2024-04-01T00:00:00+00:00[UTC]", "2024-12-31T23:59:59+00:00[UTC]") // null