| 1 | import type { ContextOptions, DateArg } from "./types.js";
|
| 2 | /**
|
| 3 | * The {@link endOfYear} function options.
|
| 4 | */
|
| 5 | export interface EndOfYearOptions<DateType extends Date = Date>
|
| 6 | extends ContextOptions<DateType> {}
|
| 7 | /**
|
| 8 | * @name endOfYear
|
| 9 | * @category Year Helpers
|
| 10 | * @summary Return the end of a year for the given date.
|
| 11 | *
|
| 12 | * @description
|
| 13 | * Return the end of a year for the given date.
|
| 14 | * The result will be in the local timezone.
|
| 15 | *
|
| 16 | * @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).
|
| 17 | * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
|
| 18 | *
|
| 19 | * @param date - The original date
|
| 20 | * @param options - The options
|
| 21 | *
|
| 22 | * @returns The end of a year
|
| 23 | *
|
| 24 | * @example
|
| 25 | * // The end of a year for 2 September 2014 11:55:00:
|
| 26 | * const result = endOfYear(new Date(2014, 8, 2, 11, 55, 0))
|
| 27 | * //=> Wed Dec 31 2014 23:59:59.999
|
| 28 | */
|
| 29 | export declare function endOfYear<
|
| 30 | DateType extends Date,
|
| 31 | ResultDate extends Date = DateType,
|
| 32 | >(date: DateArg<DateType>, options?: EndOfYearOptions<ResultDate>): ResultDate;
|