intervalsOverlapDateTime
Signature
Section titled “Signature”intervalsOverlapDateTime(aStart: string, aEnd: string, bStart: string, bEnd: string): booleanReturn true when the half-open datetime intervals [aStart, aEnd) and [bStart, bEnd) share at least one moment.
- Half-open: an interval holds every
twithstart <= t < end, soenditself is not in it (the rule CORE-6’sintervalsOverlapuses). The test isaStart < bEnd && bStart < aEnd. - Touching intervals (
aEndequal tobStart) share no moment and do not overlap. - An empty interval (
start === end) overlaps only an interval it lies strictly inside. - Uses
Temporal.PlainDateTime.comparefor comparison. - Returns
falseif either interval is invalid (start > end). - Returns
falseon 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 (excluded) |
bStart | string | ISO 8601 datetime string for the second interval start |
bEnd | string | ISO 8601 datetime string for the second interval end (excluded) |
Returns
Section titled “Returns”true if intervals overlap, or false on invalid input
Examples
Section titled “Examples”import { intervalsOverlapDateTime } from "@northguild/gmt/plain/interval";
intervalsOverlapDateTime("2024-01-01T09:00:00", "2024-01-01T13:00:00", "2024-01-01T12:00:00", "2024-01-01T17:00:00") // true