intervalDifferenceTime
Signature
Section titled “Signature”intervalDifferenceTime(aStart: string, aEnd: string, bStart: string, bEnd: string): { start: string; end: string; }[]import { intervalDifferenceTime } from "@northguild/gmt/plain/interval";Return the portion(s) of interval A not covered by interval B.
- Uses
Temporal.PlainTime.comparefor comparison. - 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).
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
aStart |
string |
ISO 8601 time string for the first interval start |
aEnd |
string |
ISO 8601 time string for the first interval end |
bStart |
string |
ISO 8601 time string for the second interval start |
bEnd |
string |
ISO 8601 time string for the second interval end |
Returns
Section titled “Returns”array of { start, end } records representing A minus B, or [] on invalid input
Examples
Section titled “Examples”intervalDifferenceTime("09:00:00", "17:00:00", "12:00:00", "13:00:00") // [{ start: "09:00:00", end: "11:59:59" }, { start: "13:00:01", end: "17:00:00" }]intervalDifferenceTime("09:00:00", "17:00:00", "09:00:00", "17:00:00") // []intervalDifferenceTime("09:00:00", "17:00:00", "12:00:00", "17:00:00") // [{ start: "09:00:00", end: "11:59:59" }]intervalDifferenceTime("invalid", "17:00:00", "12:00:00", "13:00:00") // []