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