123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126 |
- "use strict";
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.default = areIntervalsOverlapping;
- var _index = _interopRequireDefault(require("../toDate/index.js"));
- var _index2 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
- /**
- * @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.
- *
- * ### v2.0.0 breaking changes:
- *
- * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
- *
- * - The function was renamed from `areRangesOverlapping` to `areIntervalsOverlapping`.
- * This change was made to mirror the use of the word "interval" in standard ISO 8601:2004 terminology:
- *
- * ```
- * 2.1.3
- * time interval
- * part of the time axis limited by two instants
- * ```
- *
- * Also, this function now accepts an object with `start` and `end` properties
- * instead of two arguments as an interval.
- * This function now throws `RangeError` if the start of the interval is after its end
- * or if any date in the interval is `Invalid Date`.
- *
- * ```javascript
- * // Before v2.0.0
- *
- * areRangesOverlapping(
- * new Date(2014, 0, 10), new Date(2014, 0, 20),
- * new Date(2014, 0, 17), new Date(2014, 0, 21)
- * )
- *
- * // v2.0.0 onward
- *
- * 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) }
- * )
- * ```
- *
- * @param {Interval} intervalLeft - the first interval to compare. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param {Interval} intervalRight - the second interval to compare. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param {Object} [options] - the object with options
- * @param {Boolean} [options.inclusive=false] - whether the comparison is inclusive or not
- * @returns {Boolean} whether the time intervals are overlapping
- * @throws {TypeError} 2 arguments required
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid Date`
- *
- * @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
- * 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
- */
- function areIntervalsOverlapping(dirtyIntervalLeft, dirtyIntervalRight) {
- var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {
- inclusive: false
- };
- (0, _index2.default)(2, arguments);
- var intervalLeft = dirtyIntervalLeft || {};
- var intervalRight = dirtyIntervalRight || {};
- var leftStartTime = (0, _index.default)(intervalLeft.start).getTime();
- var leftEndTime = (0, _index.default)(intervalLeft.end).getTime();
- var rightStartTime = (0, _index.default)(intervalRight.start).getTime();
- var rightEndTime = (0, _index.default)(intervalRight.end).getTime(); // Throw an exception if start date is after end date or if any date is `Invalid Date`
- if (!(leftStartTime <= leftEndTime && rightStartTime <= rightEndTime)) {
- throw new RangeError('Invalid interval');
- }
- if (options.inclusive) {
- return leftStartTime <= rightEndTime && rightStartTime <= leftEndTime;
- }
- return leftStartTime < rightEndTime && rightStartTime < leftEndTime;
- }
- module.exports = exports.default;
|