72 lines
2 KiB
JavaScript
72 lines
2 KiB
JavaScript
|
import { normalizeInterval } from "./_lib/normalizeInterval.js";
|
||
|
|
import { constructFrom } from "./constructFrom.js";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The {@link eachYearOfInterval} function options.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The {@link eachYearOfInterval} function result type. It resolves the proper data type.
|
||
|
|
* It uses the first argument date object type, starting from the date argument,
|
||
|
|
* then the start interval date, and finally the end interval date. If
|
||
|
|
* a context function is passed, it uses the context function return type.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name eachYearOfInterval
|
||
|
|
* @category Interval Helpers
|
||
|
|
* @summary Return the array of yearly timestamps within the specified time interval.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Return the array of yearly timestamps 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 yearly timestamps from the month of the interval start to the month of the interval end
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Each year between 6 February 2014 and 10 August 2017:
|
||
|
|
* const result = eachYearOfInterval({
|
||
|
|
* start: new Date(2014, 1, 6),
|
||
|
|
* end: new Date(2017, 7, 10)
|
||
|
|
* })
|
||
|
|
* //=> [
|
||
|
|
* // Wed Jan 01 2014 00:00:00,
|
||
|
|
* // Thu Jan 01 2015 00:00:00,
|
||
|
|
* // Fri Jan 01 2016 00:00:00,
|
||
|
|
* // Sun Jan 01 2017 00:00:00
|
||
|
|
* // ]
|
||
|
|
*/
|
||
|
|
export function eachYearOfInterval(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.setMonth(0, 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.setFullYear(date.getFullYear() + step);
|
||
|
|
}
|
||
|
|
|
||
|
|
return reversed ? dates.reverse() : dates;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default eachYearOfInterval;
|