@burglekitt/gmt
Version:
Temporal-based date and time utilities with timezone support and polyfill integration
31 lines (30 loc) • 1.99 kB
TypeScript
/**
* Split a time interval at arbitrary `points`, producing consecutive sub-intervals.
*
* - `points` need not be sorted — they are sorted internally before splitting.
* - Points outside `[start, end]` are dropped; they cannot introduce a boundary that isn't
* inside the interval.
* - Points exactly on `start` or `end` are dropped too — they would only produce a
* zero-length sub-interval at the edge, which `divideEqually`'s zero-length case is the
* deliberate way to express, not `splitAt`'s.
* - Duplicate points collapse to a single boundary.
* - Returns `[{ start, end }]` (the whole interval, unsplit) when no valid in-range point remains.
* - Returns `[]` when `points` is not an array, when any element is not a valid ISO PlainTime
* string, or on invalid input (unparseable start/end, `start > end`).
*
* @param start ISO PlainTime string for the interval start
* @param end ISO PlainTime string for the interval end
* @param points array of ISO PlainTime strings to split at
* @returns array of `{ start, end }` records, or `[]` on invalid input
*
* @example intervalSplitAtTime("09:00:00", "17:00:00", ["12:00:00"]) // [{ start: "09:00:00", end: "12:00:00" }, { start: "12:00:00", end: "17:00:00" }]
* @example intervalSplitAtTime("09:00:00", "17:00:00", ["15:00:00", "11:00:00"]) // [{ start: "09:00:00", end: "11:00:00" }, { start: "11:00:00", end: "15:00:00" }, { start: "15:00:00", end: "17:00:00" }]
* @example intervalSplitAtTime("09:00:00", "17:00:00", ["09:00:00", "17:00:00", "20:00:00"]) // [{ start: "09:00:00", end: "17:00:00" }]
* @example intervalSplitAtTime("09:00:00", "17:00:00", []) // [{ start: "09:00:00", end: "17:00:00" }]
* @example intervalSplitAtTime("invalid", "17:00:00", ["12:00:00"]) // []
* @example intervalSplitAtTime("09:00:00", "17:00:00", ["not-a-time"]) // []
*/
export declare function intervalSplitAtTime(start: string, end: string, points: string[]): Array<{
start: string;
end: string;
}>;