intervalDifferenceZoned

Signature

intervalDifferenceZoned(aStart: string, aEnd: string, bStart: string, bEnd: string): { start: string; end: string; }[]

import { intervalDifferenceZoned } from "@northguild/gmt/zoned/interval";

Return the portion(s) of interval A not covered by interval B.

• Uses Temporal.Instant.compare for comparison (via .toInstant()).
• Returns [] when B fully covers A.
• Returns [{ start, end }] when B overlaps one edge of A (or equals A).
• Returns [{ start, end }, { start, end }] when B is fully inside A with gaps on both sides.
• Returns [] if either interval is invalid (start > end).
• Returns [] on 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 — see regex/calendar-zoned-date-time.ts.

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

array of { start, end } records representing A minus B, or [] on invalid input

Examples

intervalDifferenceZoned("2024-01-01T09:00:00+00:00[UTC]", "2024-12-31T17:00:00+00:00[UTC]", "2024-06-01T12:00:00+00:00[UTC]", "2024-07-01T13:00:00+00:00[UTC]") // [{ start: "2024-01-01T09:00:00+00:00[UTC]", end: "2024-05-31T17:00:00+00:00[UTC]" }, { start: "2024-07-01T13:00:01+00:00[UTC]", end: "2024-12-31T17:00:00+00:00[UTC]" }]
intervalDifferenceZoned("2024-01-01T09:00:00+00:00[UTC]", "2024-12-31T17:00:00+00:00[UTC]", "2024-01-01T09:00:00+00:00[UTC]", "2024-12-31T17:00:00+00:00[UTC]") // []
intervalDifferenceZoned("invalid", "2024-12-31T17:00:00+00:00[UTC]", "2024-06-01T12:00:00+00:00[UTC]", "2024-07-01T13:00:00+00:00[UTC]") // []

Source

zoned/interval/intervalDifferenceZoned.ts