79 lines
2.3 KiB
JavaScript
79 lines
2.3 KiB
JavaScript
import { toDate } from "./toDate.mjs";
|
|
|
|
/**
|
|
* The {@link areIntervalsOverlapping} function options.
|
|
*/
|
|
|
|
/**
|
|
* @name areIntervalsOverlapping
|
|
* @category Interval Helpers
|
|
* @summary Is the given time interval overlapping with another time interval?
|
|
*
|
|
* @description
|
|
* Is the given time interval overlapping with another time interval? Adjacent intervals do not count as overlapping unless `inclusive` is set to `true`.
|
|
*
|
|
* @param intervalLeft - The first interval to compare.
|
|
* @param intervalRight - The second interval to compare.
|
|
* @param options - The object with options
|
|
*
|
|
* @returns Whether the time intervals are overlapping
|
|
*
|
|
* @example
|
|
* // For overlapping time intervals:
|
|
* areIntervalsOverlapping(
|
|
* { start: new Date(2014, 0, 10), end: new Date(2014, 0, 20) },
|
|
* { start: new Date(2014, 0, 17), end: new Date(2014, 0, 21) }
|
|
* )
|
|
* //=> true
|
|
*
|
|
* @example
|
|
* // For non-overlapping time intervals:
|
|
* areIntervalsOverlapping(
|
|
* { start: new Date(2014, 0, 10), end: new Date(2014, 0, 20) },
|
|
* { start: new Date(2014, 0, 21), end: new Date(2014, 0, 22) }
|
|
* )
|
|
* //=> false
|
|
*
|
|
* @example
|
|
* // For adjacent time intervals:
|
|
* areIntervalsOverlapping(
|
|
* { start: new Date(2014, 0, 10), end: new Date(2014, 0, 20) },
|
|
* { start: new Date(2014, 0, 20), end: new Date(2014, 0, 30) }
|
|
* )
|
|
* //=> false
|
|
*
|
|
* @example
|
|
* // Using the inclusive option:
|
|
* areIntervalsOverlapping(
|
|
* { start: new Date(2014, 0, 10), end: new Date(2014, 0, 20) },
|
|
* { start: new Date(2014, 0, 20), end: new Date(2014, 0, 24) }
|
|
* )
|
|
* //=> false
|
|
*
|
|
* @example
|
|
* areIntervalsOverlapping(
|
|
* { start: new Date(2014, 0, 10), end: new Date(2014, 0, 20) },
|
|
* { start: new Date(2014, 0, 20), end: new Date(2014, 0, 24) },
|
|
* { inclusive: true }
|
|
* )
|
|
* //=> true
|
|
*/
|
|
export function areIntervalsOverlapping(intervalLeft, intervalRight, options) {
|
|
const [leftStartTime, leftEndTime] = [
|
|
+toDate(intervalLeft.start),
|
|
+toDate(intervalLeft.end),
|
|
].sort((a, b) => a - b);
|
|
const [rightStartTime, rightEndTime] = [
|
|
+toDate(intervalRight.start),
|
|
+toDate(intervalRight.end),
|
|
].sort((a, b) => a - b);
|
|
|
|
if (options?.inclusive)
|
|
return leftStartTime <= rightEndTime && rightStartTime <= leftEndTime;
|
|
|
|
return leftStartTime < rightEndTime && rightStartTime < leftEndTime;
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default areIntervalsOverlapping;
|