timepiece/node_modules/date-fns/setDayOfYear.d.ts

25 lines
802 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name setDayOfYear
* @category Day Helpers
* @summary Set the day of the year to the given date.
*
* @description
* Set the day of the year to the given date.
*
* @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).
*
* @param date - The date to be changed
* @param dayOfYear - The day of the year of the new date
*
* @returns The new date with the day of the year set
*
* @example
* // Set the 2nd day of the year to 2 July 2014:
* const result = setDayOfYear(new Date(2014, 6, 2), 2)
* //=> Thu Jan 02 2014 00:00:00
*/
export declare function setDayOfYear<DateType extends Date>(
date: DateType | number | string,
dayOfYear: number,
): DateType;