timepiece/node_modules/date-fns/eachMinuteOfInterval.d.ts

38 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 eachMinuteOfInterval} function options.
*/
export interface EachMinuteOfIntervalOptions extends StepOptions {}
/**
* @name eachMinuteOfInterval
* @category Interval Helpers
* @summary Return the array of minutes within the specified time interval.
*
* @description
* Returns the array of minutes 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 minutes from the minute of the interval start to the minute of the interval end
*
* @example
* // Each minute between 14 October 2020, 13:00 and 14 October 2020, 13:03
* const result = eachMinuteOfInterval({
* start: new Date(2014, 9, 14, 13),
* end: new Date(2014, 9, 14, 13, 3)
* })
* //=> [
* // Wed Oct 14 2014 13:00:00,
* // Wed Oct 14 2014 13:01:00,
* // Wed Oct 14 2014 13:02:00,
* // Wed Oct 14 2014 13:03:00
* // ]
*/
export declare function eachMinuteOfInterval<DateType extends Date>(
interval: Interval<DateType>,
options?: EachMinuteOfIntervalOptions,
): DateType[];