intervalXorAllUtc
Signature
Section titled “Signature”intervalXorAllUtc(intervals: { start: string; end: string; }[]): { start: string; end: string; }[]Return the symmetric difference across a list of UTC intervals — the set of instants covered by an odd number of the input intervals.
- List-form generalization of
intervalXorUtc, which is pairwise only. - Half-open: an interval holds every
twithstart <= t < end. The result is every maximal run covered an odd number of times, computed as a coverage-parity sweep over the start and end boundaries. Runs end exactly at a boundary; no boundary is ever stepped by one unit, so an interval may end on the type’s last value without overflow or midnight wrap. - Touching odd runs join into one run; an empty interval (
start === end) contributes nothing. For two intervals this is exactlyintervalXorUtc’s pairwise result. - Order of the input list does not matter; the result is sorted by start.
- Returns
[]for an empty list, and[]when every instant is covered an even number of times (e.g. two identical intervals cancel out). - Returns
[]whenintervalsis not an array, when any element is not a{ start, end }record of valid ISO UTC datetime strings, or when any element hasstart > endor a leap-second string.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
intervals | { start: string; end: string; }[] | array of { start, end } records |
Returns
Section titled “Returns”array of { start, end } records covered an odd number of times, or [] on invalid input
Members of each item
| Member | Type | Description |
|---|---|---|
start | string | The instant the interval begins at, as an ISO 8601 UTC string ending in Z. |
end | string | The first instant after the interval, in the same format as start. It is exclusive: the interval holds everything from start up to but not including this value. It is always later than start. |
Examples
Section titled “Examples”import { intervalXorAllUtc } from "@northguild/gmt/utc/interval";
intervalXorAllUtc([{ start: "2024-01-01T09:00:00Z", end: "2024-01-01T13:00:00Z" }, { start: "2024-01-01T12:00:00Z", end: "2024-01-01T17:00:00Z" }]) // [{ start: "2024-01-01T09:00:00Z", end: "2024-01-01T12:00:00Z" }, { start: "2024-01-01T13:00:00Z", end: "2024-01-01T17:00:00Z" }]