@burglekitt/gmt
Version:
Temporal-based date and time utilities with timezone support and polyfill integration
25 lines (24 loc) • 1.46 kB
TypeScript
/**
* Return the overlapping span of two time intervals, or null when they do not overlap.
*
* - Uses `Temporal.PlainTime.compare` for comparison.
* - Adjacent intervals (e.g. `aEnd === bStart`) share one instant and DO overlap.
* - Returns `null` if either interval is invalid (`start > end`).
* - Returns `null` on invalid input (wrong type, malformed strings).
*
* @param aStart ISO 8601 time string for the first interval start
* @param aEnd ISO 8601 time string for the first interval end
* @param bStart ISO 8601 time string for the second interval start
* @param bEnd ISO 8601 time string for the second interval end
* @returns `{ start, end }` with the overlapping span, or null on invalid input / no overlap
*
* @example intervalIntersectionTime("09:00:00", "17:00:00", "12:00:00", "18:00:00") // { start: "12:00:00", end: "17:00:00" }
* @example intervalIntersectionTime("09:00:00", "17:00:00", "17:00:00", "18:00:00") // { start: "17:00:00", end: "17:00:00" }
* @example intervalIntersectionTime("09:00:00", "17:00:00", "18:00:00", "20:00:00") // null
* @example intervalIntersectionTime("09:00:00", "17:00:00", "10:00:00", "11:00:00") // { start: "10:00:00", end: "11:00:00" }
* @example intervalIntersectionTime("invalid", "17:00:00", "12:00:00", "18:00:00") // null
*/
export declare function intervalIntersectionTime(aStart: string, aEnd: string, bStart: string, bEnd: string): {
start: string;
end: string;
} | null;