38 lines
1.3 KiB
TypeScript
38 lines
1.3 KiB
TypeScript
|
import type { Interval, StepOptions } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link eachHourOfInterval} function options.
|
||
|
|
*/
|
||
|
|
export interface EachHourOfIntervalOptions extends StepOptions {}
|
||
|
|
/**
|
||
|
|
* @name eachHourOfInterval
|
||
|
|
* @category Interval Helpers
|
||
|
|
* @summary Return the array of hours within the specified time interval.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Return the array of hours 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 hours from the hour of the interval start to the hour of the interval end
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Each hour between 6 October 2014, 12:00 and 6 October 2014, 15:00
|
||
|
|
* const result = eachHourOfInterval({
|
||
|
|
* start: new Date(2014, 9, 6, 12),
|
||
|
|
* end: new Date(2014, 9, 6, 15)
|
||
|
|
* })
|
||
|
|
* //=> [
|
||
|
|
* // Mon Oct 06 2014 12:00:00,
|
||
|
|
* // Mon Oct 06 2014 13:00:00,
|
||
|
|
* // Mon Oct 06 2014 14:00:00,
|
||
|
|
* // Mon Oct 06 2014 15:00:00
|
||
|
|
* // ]
|
||
|
|
*/
|
||
|
|
export declare function eachHourOfInterval<DateType extends Date>(
|
||
|
|
interval: Interval<DateType>,
|
||
|
|
options?: EachHourOfIntervalOptions,
|
||
|
|
): DateType[];
|