60 lines
2.3 KiB
JavaScript
60 lines
2.3 KiB
JavaScript
import addMinutes from "../addMinutes/index.js";
|
|
import toDate from "../toDate/index.js";
|
|
import startOfMinute from "../startOfMinute/index.js";
|
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
|
|
|
/**
|
|
* @name eachMinuteOfInterval
|
|
* @category Interval Helpers
|
|
* @summary Return the array of minutes within the specified time interval.
|
|
*
|
|
* @description
|
|
* Returns the array of minutes 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 step must be equal to or greater than 1
|
|
* @throws {TypeError} 1 argument required
|
|
* @returns {Date[]} the array with starts of minutes from the minute of the interval start to the minute of the interval end
|
|
* @throws {RangeError} `options.step` must be a number equal to or 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 minute between 14 October 2020, 13:00 and 14 October 2020, 13:03
|
|
* const result = eachMinuteOfInterval({
|
|
* start: new Date(2014, 9, 14, 13),
|
|
* end: new Date(2014, 9, 14, 13, 3)
|
|
* })
|
|
* //=> [
|
|
* // Wed Oct 14 2014 13:00:00,
|
|
* // Wed Oct 14 2014 13:01:00,
|
|
* // Wed Oct 14 2014 13:02:00,
|
|
* // Wed Oct 14 2014 13:03:00
|
|
* // ]
|
|
*/
|
|
export default function eachMinuteOfInterval(interval, options) {
|
|
var _options$step;
|
|
|
|
requiredArgs(1, arguments);
|
|
var startDate = startOfMinute(toDate(interval.start));
|
|
var endDate = toDate(interval.end);
|
|
var startTime = startDate.getTime();
|
|
var endTime = endDate.getTime();
|
|
|
|
if (startTime >= endTime) {
|
|
throw new RangeError('Invalid interval');
|
|
}
|
|
|
|
var dates = [];
|
|
var currentDate = startDate;
|
|
var step = Number((_options$step = options === null || options === void 0 ? void 0 : options.step) !== null && _options$step !== void 0 ? _options$step : 1);
|
|
if (step < 1 || isNaN(step)) throw new RangeError('`options.step` must be a number equal to or greater than 1');
|
|
|
|
while (currentDate.getTime() <= endTime) {
|
|
dates.push(toDate(currentDate));
|
|
currentDate = addMinutes(currentDate, step);
|
|
}
|
|
|
|
return dates;
|
|
} |