registration

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

@@ -1,3 +1,27 @@
+import type { ContextOptions, DateArg } from "./types.js";
+/**
+ * The {@link closestTo} function options.
+ */
+export interface ClosestToOptions<DateType extends Date = Date>
+  extends ContextOptions<DateType> {}
+/**
+ * The {@link closestTo} 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 ClosestToResult<
+  DateToCompare extends DateArg<Date>,
+  DatesType extends DateArg<Date>[],
+  Options extends ClosestToOptions | undefined,
+> =
+  Options extends ClosestToOptions<infer DateType extends Date>
+    ? DateType
+    : DateToCompare extends Date
+      ? DateToCompare
+      : DatesType extends DateArg<infer DateType>[]
+        ? DateType
+        : Date;
 /**
  * @name closestTo
  * @category Common Helpers
@@ -6,7 +30,9 @@
  * @description
  * Return a date from the array closest to the given date.
  *
- * @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 DateToCompare - Date to compare argument type.
+ * @typeParam DatesType - Dates array argument type.
+ * @typeParam Options - Options type.
  *
  * @param dateToCompare - The date to compare with
  * @param dates - The array to search
@@ -22,7 +48,12 @@
  * ])
  * //=> Tue Jan 01 2030 00:00:00
  */
-export declare function closestTo<DateType extends Date>(
-  dateToCompare: DateType | number | string,
-  dates: Array<DateType | number | string>,
-): DateType | undefined;
+export declare function closestTo<
+  DateToCompare extends DateArg<Date>,
+  DatesType extends DateArg<Date>[],
+  Options extends ClosestToOptions | undefined = undefined,
+>(
+  dateToCompare: DateToCompare,
+  dates: DatesType,
+  options?: Options | undefined,
+): ClosestToResult<DateToCompare, DatesType, Options> | undefined;