@burglekitt/gmt/dist/plain/interval/intervalXorAllDate.d.ts

Temporal-based date and time utilities with timezone support and polyfill integration

/**
 * Return the symmetric difference across a list of date intervals — the set of dates covered
 * by an odd number of the input intervals.
 *
 * - List-form generalization of `intervalXorDate`, which is pairwise only.
 * - Implemented as a coverage sweep: each interval contributes a `+1` at its start and a `-1`
 *   the day after its end; the result is every maximal run where the running coverage count is
 *   odd. For two intervals this reduces to exactly `intervalXorDate`'s pairwise result.
 * - Order of the input list does not matter; the result is sorted by start.
 * - Returns `[]` for an empty list, and `[]` when every date is covered an even number of times
 *   (e.g. two identical intervals cancel out).
 * - Returns `[]` when `intervals` is not an array, when any element is not a
 *   `{ start, end }` record of valid ISO PlainDate strings, or when any element has
 *   `start > end`.
 * - Accepts GMT calendar-annotated PlainDate strings — E5 (issue #78). Since the result is
 *   date *values*, every `start`/`end` across the whole list must carry the *same* calendar tag
 *   (or all be bare ISO); any mismatch returns `[]` (E5 decision of record D4). This also makes
 *   `.equals()`'s dedup of coincident sweep events safe — same-calendar `PlainDate`s compare
 *   equal correctly, unlike cross-calendar ones.
 *
 * @param intervals array of `{ start, end }` records, optionally calendar-annotated
 * @returns array of `{ start, end }` records covered an odd number of times, or `[]` on invalid input / mismatched calendars
 *
 * @example intervalXorAllDate([{ start: "2024-01-01", end: "2024-01-10" }, { start: "2024-01-05", end: "2024-01-15" }, { start: "2024-01-08", end: "2024-01-20" }]) // [{ start: "2024-01-01", end: "2024-01-04" }, { start: "2024-01-08", end: "2024-01-10" }, { start: "2024-01-16", end: "2024-01-20" }]
 * @example intervalXorAllDate([{ start: "2024-01-01", end: "2024-01-05" }, { start: "2024-01-01", end: "2024-01-05" }]) // [] (identical intervals cancel out)
 * @example intervalXorAllDate([]) // []
 * @example intervalXorAllDate([{ start: "2024-01-10", end: "2024-01-01" }]) // []
 */
export declare function intervalXorAllDate(intervals: Array<{
    start: string;
    end: string;
}>): Array<{
    start: string;
    end: string;
}>;