index.js 2.6 KB

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