@burglekitt/gmt
Version:
Temporal-based date and time utilities with timezone support and polyfill integration
27 lines (26 loc) • 1.3 kB
TypeScript
/**
* Collapse a list of datetime intervals into the minimum set of non-overlapping intervals.
*
* - List-form generalization of `intervalUnionDateTime`, which is pairwise only.
* - Intervals are merged when they overlap or share an endpoint exactly (adjacent intervals
* ARE merged).
* - Order of the input list does not matter; the result is sorted by start.
* - Returns `[]` for an empty list.
* - Returns `[]` when `intervals` is not an array, when any element is not a
* `{ start, end }` record of valid ISO PlainDateTime strings, or when any element has
* `start > end`.
*
* @param intervals array of `{ start, end }` records
* @returns the minimum set of non-overlapping `{ start, end }` records, sorted by start, or `[]` on invalid input
*
* @example mergeIntervalsDateTime([{ start: "2024-01-01T00:00:00", end: "2024-01-10T00:00:00" }, { start: "2024-01-05T00:00:00", end: "2024-01-15T00:00:00" }]) // [{ start: "2024-01-01T00:00:00", end: "2024-01-15T00:00:00" }]
* @example mergeIntervalsDateTime([]) // []
* @example mergeIntervalsDateTime([{ start: "2024-01-10T00:00:00", end: "2024-01-01T00:00:00" }]) // []
*/
export declare function mergeIntervalsDateTime(intervals: Array<{
start: string;
end: string;
}>): Array<{
start: string;
end: string;
}>;