timepiece/node_modules/date-fns/eachQuarterOfInterval.mjs

66 lines
1.8 KiB
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { addQuarters } from "./addQuarters.mjs";
import { startOfQuarter } from "./startOfQuarter.mjs";
import { toDate } from "./toDate.mjs";
/**
* The {@link eachQuarterOfInterval} function options.
*/
/**
* @name eachQuarterOfInterval
* @category Interval Helpers
* @summary Return the array of quarters within the specified time interval.
*
* @description
* Return the array of quarters within the specified time interval.
*
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
*
* @param interval - The interval
*
* @returns The array with starts of quarters from the quarter of the interval start to the quarter of the interval end
*
* @example
* // Each quarter within interval 6 February 2014 - 10 August 2014:
* const result = eachQuarterOfInterval({
* start: new Date(2014, 1, 6),
* end: new Date(2014, 7, 10)
* })
* //=> [
* // Wed Jan 01 2014 00:00:00,
* // Tue Apr 01 2014 00:00:00,
* // Tue Jul 01 2014 00:00:00,
* // ]
*/
export function eachQuarterOfInterval(interval, options) {
const startDate = toDate(interval.start);
const endDate = toDate(interval.end);
let reversed = +startDate > +endDate;
const endTime = reversed
? +startOfQuarter(startDate)
: +startOfQuarter(endDate);
let currentDate = reversed
? startOfQuarter(endDate)
: startOfQuarter(startDate);
let step = options?.step ?? 1;
if (!step) return [];
if (step < 0) {
step = -step;
reversed = !reversed;
}
const dates = [];
while (+currentDate <= endTime) {
dates.push(toDate(currentDate));
currentDate = addQuarters(currentDate, step);
}
return reversed ? dates.reverse() : dates;
}
// Fallback for modularized imports:
export default eachQuarterOfInterval;