1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071 |
- import { normalizeInterval } from "./_lib/normalizeInterval.js";
- import { constructFrom } from "./constructFrom.js";
- /**
- * The {@link eachMonthOfInterval} function options.
- */
- /**
- * The {@link eachMonthOfInterval} function result type. It resolves the proper data type.
- */
- /**
- * @name eachMonthOfInterval
- * @category Interval Helpers
- * @summary Return the array of months within the specified time interval.
- *
- * @description
- * Return the array of months 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 months from the month of the interval start to the month of the interval end
- *
- * @example
- * // Each month between 6 February 2014 and 10 August 2014:
- * const result = eachMonthOfInterval({
- * start: new Date(2014, 1, 6),
- * end: new Date(2014, 7, 10)
- * })
- * //=> [
- * // Sat Feb 01 2014 00:00:00,
- * // Sat Mar 01 2014 00:00:00,
- * // Tue Apr 01 2014 00:00:00,
- * // Thu May 01 2014 00:00:00,
- * // Sun Jun 01 2014 00:00:00,
- * // Tue Jul 01 2014 00:00:00,
- * // Fri Aug 01 2014 00:00:00
- * // ]
- */
- export function eachMonthOfInterval(interval, options) {
- const { start, end } = normalizeInterval(options?.in, interval);
- let reversed = +start > +end;
- const endTime = reversed ? +start : +end;
- const date = reversed ? end : start;
- date.setHours(0, 0, 0, 0);
- date.setDate(1);
- 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.setMonth(date.getMonth() + step);
- }
- return reversed ? dates.reverse() : dates;
- }
- // Fallback for modularized imports:
- export default eachMonthOfInterval;
|