40 lines
1.3 KiB
TypeScript
40 lines
1.3 KiB
TypeScript
|
import type { Interval, StepOptions } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link eachMonthOfInterval} function options.
|
||
|
|
*/
|
||
|
|
export interface EachMonthOfIntervalOptions extends StepOptions {}
|
||
|
|
/**
|
||
|
|
* @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 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 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 declare function eachMonthOfInterval<DateType extends Date>(
|
||
|
|
interval: Interval<DateType>,
|
||
|
|
options?: EachMonthOfIntervalOptions,
|
||
|
|
): DateType[];
|