intervalIntersectionUtc
Signature
Section titled “Signature”intervalIntersectionUtc(aStart: string, aEnd: string, bStart: string, bEnd: string): { start: string; end: string; }import { intervalIntersectionUtc } from "@northguild/gmt/utc/interval";Return the overlapping span of two UTC intervals, or null when they do not overlap.
- Uses
Temporal.Instant.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).
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
aStart |
string |
ISO 8601 UTC datetime string for the first interval start |
aEnd |
string |
ISO 8601 UTC datetime string for the first interval end |
bStart |
string |
ISO 8601 UTC datetime string for the second interval start |
bEnd |
string |
ISO 8601 UTC 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”intervalIntersectionUtc("2024-01-01T00:00:00Z", "2024-06-30T23:59:59Z", "2024-04-01T00:00:00Z", "2024-12-31T23:59:59Z") // { start: "2024-04-01T00:00:00Z", end: "2024-06-30T23:59:59Z" }intervalIntersectionUtc("2024-01-01T00:00:00Z", "2024-06-30T23:59:59Z", "2024-07-01T00:00:00Z", "2024-12-31T23:59:59Z") // nullintervalIntersectionUtc("2024-01-01T00:00:00Z", "2024-06-30T23:59:59Z", "2024-07-02T00:00:00Z", "2024-12-31T23:59:59Z") // nullintervalIntersectionUtc("invalid", "2024-06-30T23:59:59Z", "2024-04-01T00:00:00Z", "2024-12-31T23:59:59Z") // null