62 lines
2.1 KiB
TypeScript
62 lines
2.1 KiB
TypeScript
|
import type { ContextOptions, Interval, StepOptions } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link eachMinuteOfInterval} function options.
|
||
|
|
*/
|
||
|
|
export interface EachMinuteOfIntervalOptions<DateType extends Date = Date>
|
||
|
|
extends StepOptions,
|
||
|
|
ContextOptions<DateType> {}
|
||
|
|
/**
|
||
|
|
* The {@link eachMinuteOfInterval} function result type. It resolves the proper data type.
|
||
|
|
* It uses the first argument date object type, starting from the date argument,
|
||
|
|
* then the start interval date, and finally the end interval date. If
|
||
|
|
* a context function is passed, it uses the context function return type.
|
||
|
|
*/
|
||
|
|
export type EachMinuteOfIntervalResult<
|
||
|
|
IntervalType extends Interval,
|
||
|
|
Options extends EachMinuteOfIntervalOptions | undefined,
|
||
|
|
> = Array<
|
||
|
|
Options extends EachMinuteOfIntervalOptions<infer DateType>
|
||
|
|
? DateType
|
||
|
|
: IntervalType["start"] extends Date
|
||
|
|
? IntervalType["start"]
|
||
|
|
: IntervalType["end"] extends Date
|
||
|
|
? IntervalType["end"]
|
||
|
|
: Date
|
||
|
|
>;
|
||
|
|
/**
|
||
|
|
* @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 IntervalType - Interval type.
|
||
|
|
* @typeParam Options - Options type.
|
||
|
|
*
|
||
|
|
* @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<
|
||
|
|
IntervalType extends Interval,
|
||
|
|
Options extends EachMinuteOfIntervalOptions | undefined = undefined,
|
||
|
|
>(
|
||
|
|
interval: IntervalType,
|
||
|
|
options?: Options,
|
||
|
|
): EachMinuteOfIntervalResult<IntervalType, Options>;
|