intervalUnionDateTime
Signature
Section titled “Signature”intervalUnionDateTime(aStart: string, aEnd: string, bStart: string, bEnd: string): { start: string; end: string; }import { intervalUnionDateTime } from "@northguild/gmt/plain/interval";Return the combined span of two datetime intervals, or null when they are disjoint.
- Uses
Temporal.PlainDateTime.comparefor comparison. - Overlapping intervals return their merged span.
- Adjacent intervals (e.g.
aEnd === bStart) share one instant and ARE merged. - Returns
nullif either interval is invalid (start > end). - Returns
nullon invalid input (wrong type, malformed strings).
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
aStart |
string |
ISO 8601 datetime string for the first interval start |
aEnd |
string |
ISO 8601 datetime string for the first interval end |
bStart |
string |
ISO 8601 datetime string for the second interval start |
bEnd |
string |
ISO 8601 datetime string for the second interval end |
Returns
Section titled “Returns”{ start, end } with the merged span, or null on invalid input / disjoint intervals
Examples
Section titled “Examples”intervalUnionDateTime("2024-01-01T10:00:00", "2024-06-30T23:59:59", "2024-04-01T00:00:00", "2024-12-31T23:59:59") // { start: "2024-01-01T10:00:00", end: "2024-12-31T23:59:59" }intervalUnionDateTime("2024-01-01T10:00:00", "2024-06-30T23:59:59", "2024-06-30T23:59:59", "2024-12-31T23:59:59") // { start: "2024-01-01T10:00:00", end: "2024-12-31T23:59:59" }intervalUnionDateTime("2024-01-01T10:00:00", "2024-06-30T23:59:59", "2024-07-01T00:00:00", "2024-12-31T23:59:59") // nullintervalUnionDateTime("invalid", "2024-06-30T23:59:59", "2024-04-01T00:00:00", "2024-12-31T23:59:59") // null