1234567891011121314151617181920212223242526272829303132333435 |
- import type { ContextOptions, DateArg } from "./types.js";
- /**
- * The {@link lastDayOfYear} function options.
- */
- export interface LastDayOfYearOptions<DateType extends Date = Date>
- extends ContextOptions<DateType> {}
- /**
- * @name lastDayOfYear
- * @category Year Helpers
- * @summary Return the last day of a year for the given date.
- *
- * @description
- * Return the last day 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 - An object with options
- *
- * @returns The last day of a year
- *
- * @example
- * // The last day of a year for 2 September 2014 11:55:00:
- * const result = lastDayOfYear(new Date(2014, 8, 2, 11, 55, 00))
- * //=> Wed Dec 31 2014 00:00:00
- */
- export declare function lastDayOfYear<
- DateType extends Date,
- ResultDate extends Date = DateType,
- >(
- date: DateArg<DateType>,
- options?: LastDayOfYearOptions<ResultDate>,
- ): ResultDate;
|