12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061 |
- "use strict";
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.default = isWithinInterval;
- var _index = _interopRequireDefault(require("../toDate/index.js"));
- var _index2 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
- /**
- * @name isWithinInterval
- * @category Interval Helpers
- * @summary Is the given date within the interval?
- *
- * @description
- * Is the given date within the interval? (Including start and end.)
- *
- * @param {Date|Number} date - the date to check
- * @param {Interval} interval - the interval to check
- * @returns {Boolean} the date is within the interval
- * @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 the date within the interval:
- * isWithinInterval(new Date(2014, 0, 3), {
- * start: new Date(2014, 0, 1),
- * end: new Date(2014, 0, 7)
- * })
- * //=> true
- *
- * @example
- * // For the date outside of the interval:
- * isWithinInterval(new Date(2014, 0, 10), {
- * start: new Date(2014, 0, 1),
- * end: new Date(2014, 0, 7)
- * })
- * //=> false
- *
- * @example
- * // For date equal to interval start:
- * isWithinInterval(date, { start, end: date }) // => true
- *
- * @example
- * // For date equal to interval end:
- * isWithinInterval(date, { start: date, end }) // => true
- */
- function isWithinInterval(dirtyDate, interval) {
- (0, _index2.default)(2, arguments);
- var time = (0, _index.default)(dirtyDate).getTime();
- var startTime = (0, _index.default)(interval.start).getTime();
- var endTime = (0, _index.default)(interval.end).getTime();
- // Throw an exception if start date is after end date or if any date is `Invalid Date`
- if (!(startTime <= endTime)) {
- throw new RangeError('Invalid interval');
- }
- return time >= startTime && time <= endTime;
- }
- module.exports = exports.default;
|