index.js 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = eachHourOfInterval;
  7. var _index = _interopRequireDefault(require("../addHours/index.js"));
  8. var _index2 = _interopRequireDefault(require("../toDate/index.js"));
  9. var _index3 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  10. /**
  11. * @name eachHourOfInterval
  12. * @category Interval Helpers
  13. * @summary Return the array of hours within the specified time interval.
  14. *
  15. * @description
  16. * Return the array of hours within the specified time interval.
  17. *
  18. * @param {Interval} interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
  19. * @param {Object} [options] - an object with options.
  20. * @param {Number} [options.step=1] - the step to increment by. The value should be more than 1.
  21. * @returns {Date[]} the array with starts of hours from the hour of the interval start to the hour of the interval end
  22. * @throws {TypeError} 1 argument required
  23. * @throws {RangeError} `options.step` must be a number greater than 1
  24. * @throws {RangeError} The start of an interval cannot be after its end
  25. * @throws {RangeError} Date in interval cannot be `Invalid Date`
  26. *
  27. * @example
  28. * // Each hour between 6 October 2014, 12:00 and 6 October 2014, 15:00
  29. * const result = eachHourOfInterval({
  30. * start: new Date(2014, 9, 6, 12),
  31. * end: new Date(2014, 9, 6, 15)
  32. * })
  33. * //=> [
  34. * // Mon Oct 06 2014 12:00:00,
  35. * // Mon Oct 06 2014 13:00:00,
  36. * // Mon Oct 06 2014 14:00:00,
  37. * // Mon Oct 06 2014 15:00:00
  38. * // ]
  39. */
  40. function eachHourOfInterval(dirtyInterval, options) {
  41. var _options$step;
  42. (0, _index3.default)(1, arguments);
  43. var interval = dirtyInterval || {};
  44. var startDate = (0, _index2.default)(interval.start);
  45. var endDate = (0, _index2.default)(interval.end);
  46. var startTime = startDate.getTime();
  47. var endTime = endDate.getTime();
  48. // Throw an exception if start date is after end date or if any date is `Invalid Date`
  49. if (!(startTime <= endTime)) {
  50. throw new RangeError('Invalid interval');
  51. }
  52. var dates = [];
  53. var currentDate = startDate;
  54. currentDate.setMinutes(0, 0, 0);
  55. var step = Number((_options$step = options === null || options === void 0 ? void 0 : options.step) !== null && _options$step !== void 0 ? _options$step : 1);
  56. if (step < 1 || isNaN(step)) throw new RangeError('`options.step` must be a number greater than 1');
  57. while (currentDate.getTime() <= endTime) {
  58. dates.push((0, _index2.default)(currentDate));
  59. currentDate = (0, _index.default)(currentDate, step);
  60. }
  61. return dates;
  62. }
  63. module.exports = exports.default;