FIN INIT

node_modules/date-fns/endOfYear.d.cts

@@ -0,0 +1,32 @@
+import type { ContextOptions, DateArg } from "./types.js";
+/**
+ * The {@link endOfYear} function options.
+ */
+export interface EndOfYearOptions<DateType extends Date = Date>
+  extends ContextOptions<DateType> {}
+/**
+ * @name endOfYear
+ * @category Year Helpers
+ * @summary Return the end of a year for the given date.
+ *
+ * @description
+ * Return the end of a year for the given date.
+ * The result will be in the local timezone.
+ *
+ * @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 ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
+ *
+ * @param date - The original date
+ * @param options - The options
+ *
+ * @returns The end of a year
+ *
+ * @example
+ * // The end of a year for 2 September 2014 11:55:00:
+ * const result = endOfYear(new Date(2014, 8, 2, 11, 55, 0))
+ * //=> Wed Dec 31 2014 23:59:59.999
+ */
+export declare function endOfYear<
+  DateType extends Date,
+  ResultDate extends Date = DateType,
+>(date: DateArg<DateType>, options?: EndOfYearOptions<ResultDate>): ResultDate;