@burglekitt/gmt
Version:
Temporal-based date and time utilities with timezone support and polyfill integration
25 lines (24 loc) • 1.6 kB
TypeScript
/**
* Return the combined span of two datetime intervals, or null when they are disjoint.
*
* - Uses `Temporal.PlainDateTime.compare` for comparison.
* - Overlapping intervals return their merged span.
* - Adjacent intervals (e.g. `aEnd === bStart`) share one instant and ARE merged.
* - Returns `null` if either interval is invalid (`start > end`).
* - Returns `null` on invalid input (wrong type, malformed strings).
*
* @param aStart ISO 8601 datetime string for the first interval start
* @param aEnd ISO 8601 datetime string for the first interval end
* @param bStart ISO 8601 datetime string for the second interval start
* @param bEnd ISO 8601 datetime string for the second interval end
* @returns `{ start, end }` with the merged span, or null on invalid input / disjoint intervals
*
* @example 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" }
* @example 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" }
* @example intervalUnionDateTime("2024-01-01T10:00:00", "2024-06-30T23:59:59", "2024-07-01T00:00:00", "2024-12-31T23:59:59") // null
* @example intervalUnionDateTime("invalid", "2024-06-30T23:59:59", "2024-04-01T00:00:00", "2024-12-31T23:59:59") // null
*/
export declare function intervalUnionDateTime(aStart: string, aEnd: string, bStart: string, bEnd: string): {
start: string;
end: string;
} | null;