index.js 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = isWithinInterval;
  7. var _index = _interopRequireDefault(require("../toDate/index.js"));
  8. var _index2 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  9. /**
  10. * @name isWithinInterval
  11. * @category Interval Helpers
  12. * @summary Is the given date within the interval?
  13. *
  14. * @description
  15. * Is the given date within the interval? (Including start and end.)
  16. *
  17. * @param {Date|Number} date - the date to check
  18. * @param {Interval} interval - the interval to check
  19. * @returns {Boolean} the date is within the interval
  20. * @throws {TypeError} 2 arguments required
  21. * @throws {RangeError} The start of an interval cannot be after its end
  22. * @throws {RangeError} Date in interval cannot be `Invalid Date`
  23. *
  24. * @example
  25. * // For the date within the interval:
  26. * isWithinInterval(new Date(2014, 0, 3), {
  27. * start: new Date(2014, 0, 1),
  28. * end: new Date(2014, 0, 7)
  29. * })
  30. * //=> true
  31. *
  32. * @example
  33. * // For the date outside of the interval:
  34. * isWithinInterval(new Date(2014, 0, 10), {
  35. * start: new Date(2014, 0, 1),
  36. * end: new Date(2014, 0, 7)
  37. * })
  38. * //=> false
  39. *
  40. * @example
  41. * // For date equal to interval start:
  42. * isWithinInterval(date, { start, end: date }) // => true
  43. *
  44. * @example
  45. * // For date equal to interval end:
  46. * isWithinInterval(date, { start: date, end }) // => true
  47. */
  48. function isWithinInterval(dirtyDate, interval) {
  49. (0, _index2.default)(2, arguments);
  50. var time = (0, _index.default)(dirtyDate).getTime();
  51. var startTime = (0, _index.default)(interval.start).getTime();
  52. var endTime = (0, _index.default)(interval.end).getTime();
  53. // Throw an exception if start date is after end date or if any date is `Invalid Date`
  54. if (!(startTime <= endTime)) {
  55. throw new RangeError('Invalid interval');
  56. }
  57. return time >= startTime && time <= endTime;
  58. }
  59. module.exports = exports.default;