123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172 |
- "use strict";
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.default = eachHourOfInterval;
- var _index = _interopRequireDefault(require("../addHours/index.js"));
- var _index2 = _interopRequireDefault(require("../toDate/index.js"));
- var _index3 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
- /**
- * @name eachHourOfInterval
- * @category Interval Helpers
- * @summary Return the array of hours within the specified time interval.
- *
- * @description
- * Return the array of hours within the specified time interval.
- *
- * @param {Interval} interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param {Object} [options] - an object with options.
- * @param {Number} [options.step=1] - the step to increment by. The value should be more than 1.
- * @returns {Date[]} the array with starts of hours from the hour of the interval start to the hour of the interval end
- * @throws {TypeError} 1 argument required
- * @throws {RangeError} `options.step` must be a number greater than 1
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid Date`
- *
- * @example
- * // Each hour between 6 October 2014, 12:00 and 6 October 2014, 15:00
- * var result = eachHourOfInterval({
- * start: new Date(2014, 9, 6, 12),
- * end: new Date(2014, 9, 6, 15)
- * })
- * //=> [
- * // Mon Oct 06 2014 12:00:00,
- * // Mon Oct 06 2014 13:00:00,
- * // Mon Oct 06 2014 14:00:00,
- * // Mon Oct 06 2014 15:00:00
- * // ]
- */
- function eachHourOfInterval(dirtyInterval, options) {
- (0, _index3.default)(1, arguments);
- var interval = dirtyInterval || {};
- var startDate = (0, _index2.default)(interval.start);
- var endDate = (0, _index2.default)(interval.end);
- var startTime = startDate.getTime();
- var endTime = endDate.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');
- }
- var dates = [];
- var currentDate = startDate;
- currentDate.setMinutes(0, 0, 0);
- var step = options && 'step' in options ? Number(options.step) : 1;
- if (step < 1 || isNaN(step)) throw new RangeError('`options.step` must be a number greater than 1');
- while (currentDate.getTime() <= endTime) {
- dates.push((0, _index2.default)(currentDate));
- currentDate = (0, _index.default)(currentDate, step);
- }
- return dates;
- }
- module.exports = exports.default;
|