registration

frontend/style/node_modules/date-fns/eachYearOfInterval.d.ts

@@ -1,8 +1,28 @@
-import type { Interval, StepOptions } from "./types.js";
+import type { ContextOptions, Interval, StepOptions } from "./types.js";
 /**
  * The {@link eachYearOfInterval} function options.
  */
-export interface EachYearOfIntervalOptions extends StepOptions {}
+export interface EachYearOfIntervalOptions<DateType extends Date = Date>
+  extends StepOptions,
+    ContextOptions<DateType> {}
+/**
+ * The {@link eachYearOfInterval} 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 EachYearOfIntervalResult<
+  IntervalType extends Interval,
+  Options extends EachYearOfIntervalOptions | undefined,
+> = Array<
+  Options extends EachYearOfIntervalOptions<infer DateType>
+    ? DateType
+    : IntervalType["start"] extends Date
+      ? IntervalType["start"]
+      : IntervalType["end"] extends Date
+        ? IntervalType["end"]
+        : Date
+>;
 /**
  * @name eachYearOfInterval
  * @category Interval Helpers
@@ -11,9 +31,11 @@ export interface EachYearOfIntervalOptions extends StepOptions {}
  * @description
  * Return the array of yearly timestamps 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).
+ * @typeParam IntervalType - Interval type.
+ * @typeParam Options - Options type.
  *
  * @param interval - The interval.
+ * @param options - An object with options.
  *
  * @returns The array with starts of yearly timestamps from the month of the interval start to the month of the interval end
  *
@@ -30,7 +52,10 @@ export interface EachYearOfIntervalOptions extends StepOptions {}
  * //   Sun Jan 01 2017 00:00:00
  * // ]
  */
-export declare function eachYearOfInterval<DateType extends Date>(
-  interval: Interval<DateType>,
-  options?: EachYearOfIntervalOptions,
-): DateType[];
+export declare function eachYearOfInterval<
+  IntervalType extends Interval,
+  Options extends EachYearOfIntervalOptions | undefined = undefined,
+>(
+  interval: IntervalType,
+  options?: Options,
+): EachYearOfIntervalResult<IntervalType, Options>;