Adjust roundToX types

kossnocorp · kossnocorp · commit e02e07854e97 · 2024-03-11T12:03:18.000+08:00
diff --git a/src/roundToNearestHours/index.ts b/src/roundToNearestHours/index.ts
@@ -1,13 +1,17 @@
 import { getRoundingMethod } from "../_lib/getRoundingMethod/index.js";
 import { constructFrom } from "../constructFrom/index.js";
 import { toDate } from "../toDate/index.js";
-import type { NearestHoursOptions, RoundingOptions } from "../types";
+import type {
+  NearestHours,
+  NearestToUnitOptions,
+  RoundingOptions,
+} from "../types.js";
 
 /**
  * The {@link roundToNearestHours} function options.
  */
 export interface RoundToNearestHoursOptions
-  extends NearestHoursOptions,
+  extends NearestToUnitOptions<NearestHours>,
     RoundingOptions {}
 
 /**
diff --git a/src/roundToNearestMinutes/index.ts b/src/roundToNearestMinutes/index.ts
@@ -1,13 +1,17 @@
 import { getRoundingMethod } from "../_lib/getRoundingMethod/index.js";
 import { constructFrom } from "../constructFrom/index.js";
 import { toDate } from "../toDate/index.js";
-import type { NearestMinutesOptions, RoundingOptions } from "../types.js";
+import type {
+  NearestMinutes,
+  NearestToUnitOptions,
+  RoundingOptions,
+} from "../types.js";
 
 /**
  * The {@link roundToNearestMinutes} function options.
  */
 export interface RoundToNearestMinutesOptions
-  extends NearestMinutesOptions,
+  extends NearestToUnitOptions<NearestMinutes>,
     RoundingOptions {}
 
 /**
diff --git a/src/types.ts b/src/types.ts
@@ -280,20 +280,24 @@ export type NearestMinutes =
   | 29
   | 30;
 
-/**
- * The nearest minutes function options. Used to build function options.
- */
-export interface NearestMinutesOptions {
-  /** The nearest number of minutes to round to. E.g. `15` to round to quarter hours. */
-  nearestTo?: NearestMinutes;
-}
-
 /**
  * Nearest hour type. Goes from 1 to 12, where 1 is the nearest hour and 12
  * is nearest half a day.
  */
 export type NearestHours = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
 
-export interface NearestHoursOptions {
-  nearestTo?: NearestHours;
+/**
+ * The nearest minutes function options. Used to build function options.
+ *
+ * @deprecated Use {@link NearestToUnitOptions} instead.
+ */
+export type NearestMinutesOptions = NearestToUnitOptions<NearestMinutes>;
+
+/**
+ * The nearest unit function options. Used to build function options.
+ */
+export interface NearestToUnitOptions<Unit extends number> {
+  /** The nearest unit to round to. E.g. for minutes `15` to round to quarter
+   * hours. */
+  nearestTo?: Unit;
 }
