1 | import type { ContextOptions, DateArg } from "./types.js";
|
2 | /**
|
3 | * The {@link setDayOfYear} function options.
|
4 | */
|
5 | export interface SetDayOfYearOptions<DateType extends Date = Date>
|
6 | extends ContextOptions<DateType> {}
|
7 | /**
|
8 | * @name setDayOfYear
|
9 | * @category Day Helpers
|
10 | * @summary Set the day of the year to the given date.
|
11 | *
|
12 | * @description
|
13 | * Set the day of the year to the given date.
|
14 | *
|
15 | * @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).
|
16 | * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
|
17 | *
|
18 | * @param date - The date to be changed
|
19 | * @param dayOfYear - The day of the year of the new date
|
20 | * @param options - An object with options
|
21 | *
|
22 | * @returns The new date with the day of the year set
|
23 | *
|
24 | * @example
|
25 | * // Set the 2nd day of the year to 2 July 2014:
|
26 | * const result = setDayOfYear(new Date(2014, 6, 2), 2)
|
27 | * //=> Thu Jan 02 2014 00:00:00
|
28 | */
|
29 | export declare function setDayOfYear<
|
30 | DateType extends Date,
|
31 | ResultDate extends Date = DateType,
|
32 | >(
|
33 | date: DateArg<DateType>,
|
34 | dayOfYear: number,
|
35 | options?: SetDayOfYearOptions<ResultDate> | undefined,
|
36 | ): ResultDate;
|