timepiece/node_modules/date-fns/eachDayOfInterval.d.mts

39 lines
1.3 KiB
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import type { Interval, StepOptions } from "./types.js";
/**
* The {@link eachDayOfInterval} function options.
*/
export interface EachDayOfIntervalOptions extends StepOptions {}
/**
* @name eachDayOfInterval
* @category Interval Helpers
* @summary Return the array of dates within the specified time interval.
*
* @description
* Return the array of dates 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.
* @param options - An object with options.
*
* @returns The array with starts of days from the day of the interval start to the day of the interval end
*
* @example
* // Each day between 6 October 2014 and 10 October 2014:
* const result = eachDayOfInterval({
* start: new Date(2014, 9, 6),
* end: new Date(2014, 9, 10)
* })
* //=> [
* // Mon Oct 06 2014 00:00:00,
* // Tue Oct 07 2014 00:00:00,
* // Wed Oct 08 2014 00:00:00,
* // Thu Oct 09 2014 00:00:00,
* // Fri Oct 10 2014 00:00:00
* // ]
*/
export declare function eachDayOfInterval<DateType extends Date>(
interval: Interval<DateType>,
options?: EachDayOfIntervalOptions,
): DateType[];