69 lines
1.8 KiB
JavaScript
69 lines
1.8 KiB
JavaScript
|
import { normalizeInterval } from "./_lib/normalizeInterval.js";
|
||
|
|
import { constructFrom } from "./constructFrom.js";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The {@link eachHourOfInterval} function options.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The {@link eachHourOfInterval} function result type.
|
||
|
|
* Resolves to the appropriate date type based on inputs.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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.
|
||
|
|
*
|
||
|
|
* @typeParam IntervalType - Interval type.
|
||
|
|
* @typeParam Options - Options type.
|
||
|
|
*
|
||
|
|
* @param interval - The interval.
|
||
|
|
* @param options - An object with options.
|
||
|
|
*
|
||
|
|
* @returns The array with starts of hours from the hour of the interval start to the hour of the interval end
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Each hour between 6 October 2014, 12:00 and 6 October 2014, 15:00
|
||
|
|
* const 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
|
||
|
|
* // ]
|
||
|
|
*/
|
||
|
|
export function eachHourOfInterval(interval, options) {
|
||
|
|
const { start, end } = normalizeInterval(options?.in, interval);
|
||
|
|
|
||
|
|
let reversed = +start > +end;
|
||
|
|
const endTime = reversed ? +start : +end;
|
||
|
|
const date = reversed ? end : start;
|
||
|
|
date.setMinutes(0, 0, 0);
|
||
|
|
|
||
|
|
let step = options?.step ?? 1;
|
||
|
|
if (!step) return [];
|
||
|
|
if (step < 0) {
|
||
|
|
step = -step;
|
||
|
|
reversed = !reversed;
|
||
|
|
}
|
||
|
|
|
||
|
|
const dates = [];
|
||
|
|
|
||
|
|
while (+date <= endTime) {
|
||
|
|
dates.push(constructFrom(start, date));
|
||
|
|
date.setHours(date.getHours() + step);
|
||
|
|
}
|
||
|
|
|
||
|
|
return reversed ? dates.reverse() : dates;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default eachHourOfInterval;
|